Updated TestingBuilds (markdown)
[buildfarm-client-wiki.git] / TestingBuilds.md
index 9f90ef63d20f8b1e6a47a6802c420bfaf7371ef0..855bb1690ca932743c17cfc52ab6bd8991e4f3d6 100644 (file)
@@ -28,8 +28,8 @@ The base script which handles everything is the run_build.pl script.  The comman
 ### Valid Stages:
 * configure
 * make
-* build_docs  (optional, off by default)
-* make_test   (optional, off by default)
+* make-doc  (optional, off by default)
+* test      (optional, off by default)
 
 In each of the following sample command lines, remember that `--test` will force all steps and will not locally store the state of the git checkout nor the state of each of stage, nor will it submit the results to the server.
 
@@ -45,15 +45,15 @@ In each of the following sample command lines, remember that `--test` will force
 4. Debug mode, only run configure and make if there is a new commit, submit results to server:
 `./run_build.pl --only-steps configure,make --verbose=2`
 
-5. Run all steps, configured to also do make_test, but limit the range of tests from 1 to 9:
+5. Run all steps, only if there is a new commit, configured to also do make_test, but limit the range of tests from 1 to 9:
 `./run_build.pl --override range_test_num='1 9'`
 
-6. Just build docs, don't submit results:
-`./run_build.pl --force --only-steps=build_docs --nosend`
+6. Just build docs, don't submit results (configure builds the *Local/Makefile*, which is required for doc building) :
+`./run_build.pl --force --only-steps=configure,make-doc --nosend`
 
 7. Just build docs, equivalent command:
-`./run_build.pl --test --only-steps=build_docs`
+`./run_build.pl --test --only-steps=configure,make-doc`
 
-8. Just build docs, but allow it to submit results:
-`./run_build.pl --force --only-steps=build_docs`
+8. Just build docs, but allow it to submit results (not advised since you aren't building the actual binary) :
+`./run_build.pl --force --only-steps=configure,make-doc`