Merge pull request #769 from buildtesters/update_docs

Update Documentation

buildtest/cli/__init__.py

@@ -352,6 +352,7 @@ def config_menu(subparsers):
     subparsers_compiler_find = compilers.add_subparsers(
         description="Find new compilers and add them to detected compiler section",
         dest="compilers",
+        metavar="",
     )
 
     compiler_find = subparsers_compiler_find.add_parser(

buildtest/cli/history.py

@@ -22,8 +22,6 @@ def list_builds():
     # only filter filters that are 'build.json'
     history_files = [f for f in history_files if os.path.basename(f) == "build.json"]
 
-    print(sorted(history_files))
-
     table = {
         "id": [],
         "hostname": [],

buildtest/schemas/definitions.schema.json

@@ -80,7 +80,8 @@
           "enum": [
             "lsf",
             "slurm",
-            "cobalt"
+            "cobalt",
+            "pbs"
           ]
         },
         "user": {

buildtest/settings/config.yml

@@ -48,9 +48,9 @@ system:
       compiler:
         gcc:
           builtin_gcc:
-            cc: /usr/bin/gcc
-            fc: /usr/bin/gfortran
-            cxx: /usr/bin/g++
+            cc: gcc
+            fc: gfortran
+            cxx: g++
 
     # location of log directory
     # logdir: /tmp/

docs/builder.rst

@@ -3,9 +3,6 @@
 Build and Test Process
 ======================
 
-Pipeline
----------
-
 The `buildtest build` command is responsible for building and running tests. Every buildspec
 goes through a pipeline that discovers buildspecs, validates the buildspec and builds and runs
 the test. The buildspec must go through each stage of the pipeline, if it fails in one of the stage,
@@ -14,7 +11,7 @@ the buildspec will be ignored.
 .. image:: _static/GeneralPipeline.png
 
 Discover Buildspecs
-~~~~~~~~~~~~~~~~~~~~
+---------------------
 
 buildtest will discover buildspecs based on command line arguments since you can
 build by file, directory, executor, or tags.  In **discover** stage, buildtest
@@ -28,7 +25,7 @@ and one of the sub-schemas, check :ref:`parsing buildspecs <parse_stage>` sectio
 .. _parse_stage:
 
 Parse Buildspecs
-~~~~~~~~~~~~~~~~~
+---------------------
 
 A buildspec file may contain one or more test sections specified via ``buildspec``
 field. Each test is validated by a sub-schema specified by ``type`` field.
@@ -43,7 +40,7 @@ Buildspecs will be ignored if it fails validation process for instance you may h
 Invalid buildspecs won't be sent to **build** stage since we can't reliably build a test-script.
 
 Building Buildspecs
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
 
 buildtest will send all valid buildspecs to **build** phase which is responsible for building
 a shell-script from the buildspec file. In this stage, we create a **Builder** object
@@ -57,7 +54,7 @@ of failure, buildtest will raise an exception and buildspec will be ignored. The
 stage
 
 Running Buildspecs
-~~~~~~~~~~~~~~~~~~~~
+---------------------
 
 In this stage, we run the test based on :ref:`executors <configuring_executors>` defined in configuration file. buildtest will
 select the executor defined by ``executor`` property in buildspec which is responsible for running the test. There is a `BaseExecutor <https://github.com/buildtesters/buildtest/blob/devel/buildtest/executors/base.py>`_