diff options
author | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-06-21 21:04:28 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-21 21:04:28 +0000 |
commit | e126922df3d5ac193d34b9a3b8bcb88625adec4a (patch) | |
tree | c2b6b96731cb4c592c996fd2d89324bef6e08329 /doc/sphinx/userguide | |
parent | 868ca678c1a7e8355cf446df778c2fe0dff1bf9a (diff) | |
parent | 295e58ad1d2cff08b665b7e02d94e52dd15e0c57 (diff) |
Merge pull request #294 from sifive/update-docs
Update docs
Diffstat (limited to 'doc/sphinx/userguide')
-rw-r--r-- | doc/sphinx/userguide/buildingcoreip.rst | 32 | ||||
-rw-r--r-- | doc/sphinx/userguide/buildingdevboard.rst | 4 |
2 files changed, 2 insertions, 34 deletions
diff --git a/doc/sphinx/userguide/buildingcoreip.rst b/doc/sphinx/userguide/buildingcoreip.rst deleted file mode 100644 index 7fd821e..0000000 --- a/doc/sphinx/userguide/buildingcoreip.rst +++ /dev/null @@ -1,32 +0,0 @@ -Building for SiFive CoreIP -========================== - -Building an Example -------------------- - -To compile a bare-metal RISC-V program: - -.. code-block:: bash - - make [PROGRAM=hello] [TARGET=coreip-e31-rtl] [CONFIGURATION=debug] 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 -the build script to build the ``hello`` example for the ``coreip-e31`` target -with the ``debug`` build configuration. If, for example, you wished to build -the ``timer-interrupt`` example for the S51 Core IP target with the ``release`` -configuration, you would instead run the command - -.. code-block:: bash - - make PROGRAM=timer-interrupt TARGET=coreip-s51-rtl CONFIGURATION=release software - -Cleaning a Target Program Build Directory ------------------------------------------ - -The ``clean`` target can be used to restore a target program's directory to a clean state. - -.. code-block:: bash - - make [PROGRAM=hello] [TARGET=coreip-e31-rtl] [CONFIGURATION=debug] clean - diff --git a/doc/sphinx/userguide/buildingdevboard.rst b/doc/sphinx/userguide/buildingdevboard.rst index d972b3a..5d46943 100644 --- a/doc/sphinx/userguide/buildingdevboard.rst +++ b/doc/sphinx/userguide/buildingdevboard.rst @@ -14,12 +14,12 @@ 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 the build script to build the ``hello`` example for the ``sifive-hifive1`` target using the ``debug`` build configuration. If, for example, you wished to build -the ``timer-interrupt`` example for the S51 Arty FPGA Evaluation target using +the ``timer-interrupt`` example for the Freedom E310 Arty FPGA Evaluation target using the ``release`` build configuration, you would instead run the command .. code-block:: bash - make PROGRAM=timer-interrupt TARGET=coreip-s51-arty CONFIGURATION=release software + make PROGRAM=timer-interrupt TARGET=freedom-e310-arty CONFIGURATION=release software Uploading to the Target Board ----------------------------- |