From 5a0d27356e2d1e48a4b1964379107078b6672277 Mon Sep 17 00:00:00 2001 From: Mark Harrah Date: Sat, 23 Nov 2013 19:32:03 -0500 Subject: [PATCH] Docs: Document warn, --warn, etc... in howto --- src/sphinx/Howto/logging.rst | 58 ++++++++++++++++++++++-------------- src/sphinx/faq.rst | 23 +++----------- 2 files changed, 39 insertions(+), 42 deletions(-) diff --git a/src/sphinx/Howto/logging.rst b/src/sphinx/Howto/logging.rst index d7ac23616..98288170a 100644 --- a/src/sphinx/Howto/logging.rst +++ b/src/sphinx/Howto/logging.rst @@ -6,7 +6,7 @@ Configure and use logging :id: last :title: View the logging output of the previously executed command :type: command - + last When a command is run, more detailed logging output is sent to a file than to the screen (by default). @@ -17,10 +17,10 @@ For example, the output of :key:`run` when the sources are uptodate is: .. code-block:: console > run - [info] Running A + [info] Running A Hi! [success] Total time: 0 s, completed Feb 25, 2012 1:00:00 PM - + The details of this execution can be recalled by running `last`: @@ -28,8 +28,8 @@ The details of this execution can be recalled by running `last`: > last [debug] Running task... Cancelable: false, max worker threads: 4, check cycles: false - [debug] - [debug] Initial source changes: + [debug] + [debug] Initial source changes: [debug] removed:Set() [debug] added: Set() [debug] modified: Set() @@ -37,15 +37,15 @@ The details of this execution can be recalled by running `last`: [debug] Modified external sources: Set() [debug] Modified binary dependencies: Set() [debug] Initial directly invalidated sources: Set() - [debug] + [debug] [debug] Sources indirectly invalidated by: [debug] product: Set() [debug] binary dep: Set() [debug] external source: Set() [debug] Initially invalidated: Set() - [debug] Copy resource mappings: - [debug] - [info] Running A + [debug] Copy resource mappings: + [debug] + [info] Running A [debug] Starting sandboxed run... [debug] Waiting for threads to exit or System.exit to be called. [debug] Classpath: @@ -64,7 +64,7 @@ Configuration of the logging level for the console and for the backing file are :id: tasklast :title: View the previous logging output of a specific task :type: command - + last compile When a task is run, more detailed logging output is sent to a file than to the screen (by default). @@ -87,8 +87,8 @@ For example, .. code-block:: console > last compile - [debug] - [debug] Initial source changes: + [debug] + [debug] Initial source changes: [debug] removed:Set() [debug] added: Set(/home/mark/tmp/a/b/A.scala) [debug] modified: Set() @@ -112,7 +112,7 @@ and: :id: printwarnings :title: Show warnings from the previous compilation :type: command - + printWarnings The Scala compiler does not print the full details of warnings by default. @@ -136,23 +136,35 @@ For example, [warn] A.scala:2: method error in object Predef is deprecated: Use sys.error(message) instead [warn] def x = error("Failed.") [warn] ^ - + .. howto:: :id: level :title: Change the logging level globally :type: command - - set every logLevel := Level.Debug -The amount of logging is controlled by the :key:`logLevel` setting, which takes values from the `Level` enumeration. -Valid values are `Error`, `Warn`, `Info`, and `Debug` in order of increasing verbosity. -To change the global logging level, set `logLevel in Global`. -For example, to set it temporarily from the sbt prompt, + warn + +The quickest way to change logging levels is by using the `error`, `warn`, `info`, or `debug` commands. +These set the default logging level for commands and tasks. +For example, .. code-block:: console - > set logLevel in Global := Level.Warn + > warn +will by default show only warnings and errors. +To set the logging level before any commands are executed on startup, use `--` before the logging level. For example, + +.. code-block:: console + + $ sbt --warn + > compile + [warn] there were 2 feature warning(s); re-run with -feature for details + [warn] one warning found + [success] Total time: 4 s, completed ... + > + +The logging level can be overridden at a finer granularity, which is described next. .. howto:: :id: tasklevel @@ -188,7 +200,7 @@ See the section on `printWarnings <#printwarnings>`_ and the sections on `previo :id: trace :title: Configure printing of stack traces :type: command - + set every traceLevel := 5` By default, sbt hides the stack trace of most exceptions thrown during execution. @@ -219,7 +231,7 @@ To change the trace printing behavior for a single project, configuration, or ta :id: nobuffer :title: Print the output of tests immediately instead of buffering :type: setting - + logBuffered := false By default, sbt buffers the logging output of a test until the whole class finishes. diff --git a/src/sphinx/faq.rst b/src/sphinx/faq.rst index b44c7d0f7..29738dab8 100644 --- a/src/sphinx/faq.rst +++ b/src/sphinx/faq.rst @@ -290,7 +290,7 @@ ProGuard jars in order to run the tool. First, define and add the new configurat ivyConfigurations += ProguardConfig -Then, +Then, :: @@ -487,8 +487,8 @@ as a jar or pom.xml. An example of such an error is: :: [warn] problem while downloading module descriptor: - http://repo1.maven.org/maven2/commons-fileupload/commons-fileupload/1.2.2/commons-fileupload-1.2.2.pom: - invalid sha1: expected=ad3fda4adc95eb0d061341228cc94845ddb9a6fe computed=0ce5d4a03b07c8b00ab60252e5cacdc708a4e6d8 (1070ms) + http://repo1.maven.org/maven2/commons-fileupload/commons-fileupload/1.2.2/commons-fileupload-1.2.2.pom: + invalid sha1: expected=ad3fda4adc95eb0d061341228cc94845ddb9a6fe computed=0ce5d4a03b07c8b00ab60252e5cacdc708a4e6d8 (1070ms) The invalid checksum should generally be reported to the repository owner (as `was done `_ @@ -524,7 +524,7 @@ that files in `~/.sbt/plugins` are only to be used by sbt itself, not as part of the general build definition. If you define your plugins in a file under *that* directory, they won't foul up your cross-compilations. Any file name ending in `.sbt` will do, but most people use -`~/.sbt/plugins/build.sbt` or `~/.sbt/plugins/plugins.sbt`. +`~/.sbt/plugins/build.sbt` or `~/.sbt/plugins/plugins.sbt`. Miscellaneous ------------- @@ -650,21 +650,6 @@ this behaviour by adding one of the following to your `build.sbt`: // Execute everything serially (including compilation and tests) parallelExecution := false -How do I set log levels in |version| vs. 0.7? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -`warn`, `info`, `debug` and `error` don't work any more. - -The new syntax in the sbt |version| shell is: :: - - > set logLevel := Level.Warn` - -Or in your `build.sbt` file write: - -:: - - logLevel := Level.Warn - What happened to the web development and Web Start support since 0.7? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~