From d09ab8893043125ea5d6c41aeaf9f895b8c1dda3 Mon Sep 17 00:00:00 2001 From: Mark Harrah Date: Mon, 1 Oct 2012 07:47:45 -0400 Subject: [PATCH] Integrating recent changes to the wiki: commit 7ebbd8ea455bb59c7c2ef58ce706cb0c60148d22 Author: havocp Date: Sun Sep 30 14:06:21 2012 -0700 Try to explain briefly what a command is at the top commit 8c19257aeeb488a7121090d70698574b1041044e Author: syrix Date: Wed Sep 26 18:22:55 2012 -0700 Replace invalid link to Knockoff --- src/sphinx/Extending/Commands.rst | 8 ++++++++ src/sphinx/Extending/Plugins.rst | 2 +- src/sphinx/home.rst | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/sphinx/Extending/Commands.rst b/src/sphinx/Extending/Commands.rst index 3fcaba84d..d75407747 100644 --- a/src/sphinx/Extending/Commands.rst +++ b/src/sphinx/Extending/Commands.rst @@ -2,9 +2,17 @@ Commands ======== +What is a "command"? +==================== + +A "command" looks similar to a task: it's a named operation that can be executed from the sbt console. + +However, a command's implementation takes as its parameter the entire state of the build (represented by :doc:`/Extending/Build-State`) and computes a new :doc:`/Extending/Build-State`. This means that a command can look at or modify other sbt settings, for example. Typically, you would resort to a command when you need to do something that's impossible in a regular task. + Introduction ============ + There are three main aspects to commands: 1. The syntax used by the user to invoke the command, including: diff --git a/src/sphinx/Extending/Plugins.rst b/src/sphinx/Extending/Plugins.rst index 91f629867..c48cf28b9 100644 --- a/src/sphinx/Extending/Plugins.rst +++ b/src/sphinx/Extending/Plugins.rst @@ -8,7 +8,7 @@ Introduction A plugin is essentially a way to use external code in a build definition. A plugin can be a library used to implement a task. For example, you might use -`Knockoff `_ to write a +`Knockoff `_ to write a markdown processing task. A plugin can define a sequence of sbt Settings that are automatically added to all projects or that are explicitly declared for selected projects. For example, a plugin might add a diff --git a/src/sphinx/home.rst b/src/sphinx/home.rst index 542124f85..bdd52c229 100644 --- a/src/sphinx/home.rst +++ b/src/sphinx/home.rst @@ -43,7 +43,7 @@ Getting Started To get started, *please read* the :doc:`Getting Started Guide `. You will save yourself a *lot* of time if you have the right understanding of the big picture up-front. -All documentation may be found via the `table of contents `. +All documentation may be found via the :doc:`table of contents `. The mailing list is at http://groups.google.com/group/simple-build-tool/topics and should be used for discussions and questions. Questions may also be asked at `Stack Overflow `_.