Merge pull request #64 from PRUNERS/documentation-review

Documentation review
PRUNERS · Jun 22, 2017 · a5f4c56 · a5f4c56
2 parents 17fb934 + 3c2a234
commit a5f4c56
Show file tree

Hide file tree

Showing 15 changed files with 220 additions and 267 deletions.
diff --git a/documentation/AddingLitmusTests.md b/documentation/AddingLitmusTests.md
diff --git a/documentation/DisableOrRemoveTests.md b/documentation/DisableOrRemoveTests.md
diff --git a/documentation/InputGenerator.md b/documentation/InputGenerator.md
diff --git a/documentation/README.md b/documentation/README.md
@@ -0,0 +1,16 @@
+# Documentation Table Of Contents
+
+[Return to top-level README file](../README.md)
+
+* [Installation](installation.md)
+* [Litmus Tests](litmus-tests.md)
+* [FLiT Command-Line](flit-command-line.md)
+* [FLiT Configuration File](flit-configuration-file.md)
+  * [Available Compiler Flags](available-compiler-flags.md)
+* [Writing Test Cases](writing-test-cases.md)
+* [Database Structure](database-structure.md)
+* [Analyze Results](analyze-results.md)
+* **Extra Tools**
+  * [Autogenerated Tests](autogenerated-tests.md)
+  * [Test Input Generator](test-input-generator.md)
+
diff --git a/documentation/analyze-results.md b/documentation/analyze-results.md
@@ -1,6 +1,18 @@
 # Analyze Results
 
+[Prev](database-structure.md)
+|
+[Table of Contents](README.md)
+|
+[Next](autogenerated-tests.md)
+
 Since the database functionality is a little broken right now, the analysis is
 also not available.  When the database functionality is fixed, you can expect
 to be here some instructions on how to generate useful charts from the gathered
 data.
+
+[Prev](database-structure.md)
+|
+[Table of Contents](README.md)
+|
+[Next](autogenerated-tests.md)
diff --git a/documentation/autogenerated-tests.md b/documentation/autogenerated-tests.md
@@ -1,8 +1,14 @@
 # Autogenerated Tests
 
+[Prev](analyze-results.md)
+|
+[Table of Contents](README.md)
+|
+[Next](test-input-generator.md)
+
 There is some code to randomly generate test cases.  For now, these autogenerated test cases are limited to a small number of arithmetic expressions, almost all of which demonstrate variability on at least one flag.
 
-This tool requires an additional package dependency, `numpy`.
+This tool requires an additional python package dependency, `numpy`.
 
 ```bash
 pip install numpy
@@ -14,3 +20,9 @@ To run this generator, you will probably want an already initialized flit test d
 FLiT/gensrc/gensrc.py --outdir project/flit-tests/tests 1
 ```
 
+[Prev](analyze-results.md)
+|
+[Table of Contents](README.md)
+|
+[Next](test-input-generator.md)
+
diff --git a/documentation/available-compiler-flags.md b/documentation/available-compiler-flags.md
@@ -1,5 +1,11 @@
 # Available Compiler Flags
 
+[Prev](flit-configuration-file.md)
+|
+[Table of Contents](README.md)
+|
+[Next](writing-test-cases.md)
+
 Convenient TOML lists:
 
 * [GCC](#gcc)
@@ -162,3 +168,9 @@ switches = [
   '--prec-sqrt=true',
 ]
 ```
+
+[Prev](flit-configuration-file.md)
+|
+[Table of Contents](README.md)
+|
+[Next](writing-test-cases.md)
diff --git a/documentation/d_all_bihexal.pdf b/documentation/d_all_bihexal.pdf
diff --git a/documentation/database-structure.md b/documentation/database-structure.md
@@ -1,6 +1,18 @@
 # Database Structure
 
-The database functionality is a little broken.  When the database is working
-again, you can expect to be here the fields and tables (i.e. the database
-specifications) here with a little explanation of each so that you can browse
-the test results easily.
+[Prev](writing-test-cases.md)
+|
+[Table of Contents](README.md)
+|
+[Next](analyze-results.md)
+
+The database functionality is a little broken.  When the database is
+working again, you can expect the fields and tables (i.e. the database
+specifications) to be here with a little explanation of each so that
+you can browse the test results easily.
+
+[Prev](writing-test-cases.md)
+|
+[Table of Contents](README.md)
+|
+[Next](analyze-results.md)
diff --git a/documentation/flit-command-line.md b/documentation/flit-command-line.md
@@ -1,27 +1,31 @@
 # FLiT Command-Line
 
+[Prev](litmus-tests.md)
+|
+[Table of Contents](README.md)
+|
+[Next](flit-configuration-file.md)
+
 FLiT comes with a command-line tool called `flit`.  This command-line tool is
 simply a symbolic link to `flit.py`.  In the repository, it is located in
 `scripts/flitcli/flit.py`.  When installed, it is installed in
 `<PREFIX>/share/flit/scripts/flit.py`.
 
 This command is split up into many subcommands.  Most of it is self documented.
-Simply call
+For more information, simply call:
 
 ```bash
 flit --help
 ```
 
-for more information.
-
 Possible subcommands:
 
 * [flit help](#flit-help): display help for a specific subcommand
 * [flit init](#flit-init): Initializes a flit test directory for use
 * [flit update](#flit-update): Updates the Makefile based on `flit-config.toml`
 * [flit check](#flit-check): Verifies the correctness of a config file
 * [flit run](#flit-run): Run flit on the configured remote machine(s)
-* [flit analyze](#flit-analyze): Runs analysis on a previous flit run
+* [flit analyze](#flit-analyze): Performs analysis on a previous flit run
 
 ## flit help
 
@@ -45,8 +49,7 @@ be up to date than this markdown description.
 ## flit init
 
 Initializes a flit test directory for use. It will initialize the directory by
-copying the default configuration file into the given directory. If a
-configuration file already exists, this command does nothing. The config file
+copying the default configuration file into the given directory. The config file
 is called `flit-config.toml`.
 
 To see how to modify `flit-config.toml`, see the documentation for [FLiT
@@ -84,10 +87,10 @@ _not yet implemented_
 
 This command only verifies the correctness of the configurations you have for
 your flit tests. As part of this verification, this command checks to see if
-the remote connections are capable of being done, such as the connection to
+it is possible to establish the remote connections, such as the connection to
 the machines to run the software, the connection to the database machine, and
 the connection to the database machine from the run machine. You may need to
-provide a few SSH passwords to do this check.
+provide a few SSH passwords to perform this check.
 
 Since this subcommand is not yet implemented, it may change in nature when it
 does finally get implemented.
@@ -98,7 +101,7 @@ _not yet implemented_
 
 Run flit on the configured remote machine(s). Note that you may need to
 provide a password for SSH, but that should be taken care of pretty early on
-in the process. The results should be sent to the database computer for later
+in the process. The results will be sent to the database computer for later
 analysis.
 
 ## flit analyze
@@ -109,3 +112,9 @@ Runs analysis on a previous flit run. The analysis will be of the current flit
 repository and will create a directory called analysis inside of the flit
 directory.
 
+[Prev](litmus-tests.md)
+|
+[Table of Contents](README.md)
+|
+[Next](flit-configuration-file.md)
+