From 54e77f235fb7f3c7c211a489939a039a6bba4a0f Mon Sep 17 00:00:00 2001 From: Josh Holtrop Date: Wed, 22 May 2019 23:31:37 -0400 Subject: [PATCH] finish documentation for command-line operations --- doc/user_guide.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/user_guide.md b/doc/user_guide.md index 2689162..b15b878 100644 --- a/doc/user_guide.md +++ b/doc/user_guide.md @@ -140,7 +140,40 @@ Such configuration checks can include: * verifying presence of a library * verifying presence of an executable +## Build Operation +If a `build` operation is requested and a `configure` operation has not yet +been performed, a `configure` operation will be automatically invoked. + +The `build` operation will execute all builders registered to produce build +targets. + +## Clean Operation + +A `clean` operation will remove all built target files. +It will not remove items installed by an `install` operation. +It will not remove the cached configuration options. + +## Distclean Operation + +A `distclean` operation will remove all built target files and all cached +configuration options. +Generally it will get the project directory back to the state it was in when +unpacked before any configuration or build operations took place. +It will not removed items installed by an `install` operation. + +## Install Operation + +An `install` operation will perform a `build` (and if necessary, first a +`configure` as well). +In addition it will execute any `Install` or `InstallDirectory` builders to +install items into the specified install directory. + +## Uninstall Operation + +An `uninstall` operation will remove any items installed by an `install` +operation. +It will not remove all built target files, just the installed copies. # Build Script Authoring