Merge pull request #198 from sifive/update-docs

Update docs with latest SDK contents
sifive · Mar 7, 2019 · c6c0fbf · c6c0fbf
2 parents 7b036c0 + 4978fca
commit c6c0fbf
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 9 deletions.
diff --git a/doc/html b/doc/html
diff --git a/doc/sphinx/contents.rst b/doc/sphinx/contents.rst
@@ -11,20 +11,35 @@ Freedom E SDK comes packaged with the following board support packages under the
 
   - sifive-hifive1
 
+- SiFive HiFive 1 Rev B
+
+  - sifive-hifive1-revb
+
 - `SiFive Freedom E310 Arty <https://github.com/sifive/freedom>`_
 
   - freedom-e310-arty
 
-- SiFive CoreIP
+- SiFive CoreIP RTL
 
-  - coreip-e31
-  - coreip-s51
+  - coreip-e20-rtl
+  - coreip-e21-rtl
+  - coreip-e24-rtl
+  - coreip-e31-rtl
+  - coreip-s51-rtl
+  - coreip-s54-rtl
+  - coreip-e76-rtl
+  - coreip-s76-rtl
 
 - SiFive CoreIP Arty FPGA Evaluation targets
 
+  - coreip-e20-arty
+  - coreip-e21-arty
   - coreip-e24-arty
   - coreip-e31-arty
   - coreip-s51-arty
+  - coreip-s54-arty
+  - coreip-e76-arty
+  - coreip-s76-arty
 
 The board support files for the Freedom Metal library are located entirely
 within a single target directory in ``bsp/<target>/``. For example, the HiFive 1
@@ -38,12 +53,12 @@ and consist of the following:
     so that users of Freedom Metal are aware of what features and peripherals
     are available on the target.
 
-* ``mee.h``
+* ``metal.h``
 
   - The Freedom Metal machine header which is used internally to Freedom Metal
     to instantiate structures to support the target device.
 
-* ``mee.lds``
+* ``metal.lds``
 
   - The linker script for the target device.
 
@@ -75,10 +90,18 @@ Example Programs
 
 The example programs can be found under the ``software/`` directory.
 
+- empty
+
+  - An empty project. Serves as a good starting point for your own program.
+
 - hello
 
   - Prints "Hello, World!" to stdout, if a serial device is present on the target.
 
+- example-coreip-welcome
+
+  - Prints a welcome message and interacts with the LEDs.
+
 - return-pass
 
   - Returns status code 0 indicating program success.

diff --git a/doc/sphinx/userguide/buildingcoreip.rst b/doc/sphinx/userguide/buildingcoreip.rst
@@ -8,7 +8,7 @@ To compile a bare-metal RISC-V program:
 
 .. code-block:: bash
 
-   make [PROGRAM=hello] [TARGET=coreip-e31] software
+   make [PROGRAM=hello] [TARGET=coreip-e31-rtl] software
 
 The square brackets in the above command indicate optional parameters for the
 Make invocation. As you can see, the default values of these parameters tell
@@ -18,7 +18,7 @@ Core IP target, you would instead run the command
 
 .. code-block:: bash
 
-   make PROGRAM=timer-interrupt TARGET=coreip-s51 software
+   make PROGRAM=timer-interrupt TARGET=coreip-s51-rtl software
 
 Cleaning a Target Program Build Directory
 -----------------------------------------
@@ -27,5 +27,5 @@ The ``clean`` target can be used to restore a target program's directory to a cl
 
 .. code-block:: bash
 
-   make [PROGRAM=hello] [TARGET=coreip-e31] clean
+   make [PROGRAM=hello] [TARGET=coreip-e31-rtl] clean
+1 −1		.buildinfo
+ −		.doctrees/contents.doctree
+ −		.doctrees/environment.pickle
+ −		.doctrees/index.doctree
+ −		.doctrees/userguide.doctree
+ −		.doctrees/userguide/buildingcoreip.doctree
+ −		.doctrees/userguide/buildingdevboard.doctree
+ −		.doctrees/userguide/installing.doctree
+ −		.doctrees/userguide/standalone.doctree
+28 −5		_sources/contents.rst.txt
+3 −3		_sources/userguide/buildingcoreip.rst.txt
+5 −5		_sources/userguide/buildingdevboard.rst.txt
+9 −0		_sources/userguide/installing.rst.txt
+1 −1		_sources/userguide/standalone.rst.txt
+1 −1		_static/documentation_options.js
+29 −6		contents.html
+1 −1		genindex.html
+2 −3		index.html
+ −		objects.inv
+1 −1		search.html
+1 −1		searchindex.js
+2 −7		userguide.html
+4 −5		userguide/buildingcoreip.html
+6 −7		userguide/buildingdevboard.html
+8 −2		userguide/installing.html
+2 −5		userguide/standalone.html