summaryrefslogtreecommitdiff
path: root/doc/sphinx
diff options
context:
space:
mode:
authorNathaniel Graff <nathaniel.graff@sifive.com>2019-03-13 16:55:29 +0000
committerGitHub <noreply@github.com>2019-03-13 16:55:29 +0000
commita08201f87076002f585edac7e94b28c7ebf22cc1 (patch)
tree9ab34c83711fa9dff0b4719fc6a4b50bcd97af17 /doc/sphinx
parent97273d31d812b3ead12fa050fd90c03dafa4f26c (diff)
parent74fa7c2f23d7639781cf23101488d797cd06aec6 (diff)
Merge pull request #200 from sifive/debugrelease
Support Debug/Release build configurations
Diffstat (limited to 'doc/sphinx')
-rw-r--r--doc/sphinx/userguide/buildingcoreip.rst13
-rw-r--r--doc/sphinx/userguide/buildingdevboard.rst17
-rw-r--r--doc/sphinx/userguide/standalone.rst7
3 files changed, 17 insertions, 20 deletions
diff --git a/doc/sphinx/userguide/buildingcoreip.rst b/doc/sphinx/userguide/buildingcoreip.rst
index 986ad68..7fd821e 100644
--- a/doc/sphinx/userguide/buildingcoreip.rst
+++ b/doc/sphinx/userguide/buildingcoreip.rst
@@ -8,17 +8,18 @@ To compile a bare-metal RISC-V program:
.. code-block:: bash
- make [PROGRAM=hello] [TARGET=coreip-e31-rtl] software
+ 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.
-If, for example, you wished to build the ``timer-interrupt`` example for the S51
-Core IP target, you would instead run the command
+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 software
+ make PROGRAM=timer-interrupt TARGET=coreip-s51-rtl CONFIGURATION=release software
Cleaning a Target Program Build Directory
-----------------------------------------
@@ -27,5 +28,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-rtl] clean
+ 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 a5d364d..d972b3a 100644
--- a/doc/sphinx/userguide/buildingdevboard.rst
+++ b/doc/sphinx/userguide/buildingdevboard.rst
@@ -8,17 +8,18 @@ To compile a bare-metal RISC-V program:
.. code-block:: bash
- make [PROGRAM=hello] [TARGET=sifive-hifive1] software
+ make [PROGRAM=hello] [TARGET=sifive-hifive1] [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 ``sifive-hifive1`` target.
-If, for example, you wished to build the ``timer-interrupt`` example for the S51
-Arty FPGA Evaluation target, you would instead run the command
+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 ``release`` build configuration, you would instead run the command
.. code-block:: bash
- make PROGRAM=timer-interrupt TARGET=coreip-s51-arty software
+ make PROGRAM=timer-interrupt TARGET=coreip-s51-arty CONFIGURATION=release software
Uploading to the Target Board
-----------------------------
@@ -32,7 +33,7 @@ the development board into your computer and running the following command:
.. code-block:: bash
- make [PROGRAM=hello] [TARGET=sifive-hifive1] upload
+ make [PROGRAM=hello] [TARGET=sifive-hifive1] [CONFIGURATION=debug] upload
Debugging a Target Program
--------------------------
@@ -49,7 +50,7 @@ the development board into your computer and running the following command:
.. code-block:: bash
- make [PROGRAM=hello] [TARGET=sifive-hifive1] debug
+ make [PROGRAM=hello] [TARGET=sifive-hifive1] [CONFIGURATION=debug] debug
Cleaning a Target Program Build Directory
-----------------------------------------
@@ -58,5 +59,5 @@ The ``clean`` target can be used to restore a target program's directory to a cl
.. code-block:: bash
- make [PROGRAM=hello] [TARGET=sifive-hifive1] clean
+ make [PROGRAM=hello] [TARGET=sifive-hifive1] [CONFIGURATION=debug] clean
diff --git a/doc/sphinx/userguide/standalone.rst b/doc/sphinx/userguide/standalone.rst
index ee31362..e71ecaa 100644
--- a/doc/sphinx/userguide/standalone.rst
+++ b/doc/sphinx/userguide/standalone.rst
@@ -8,12 +8,7 @@ Legacy Freedom E SDK.
``STANDALONE_DEST`` is a required argument to provide the desired project location.
-You can include the argument ``INCLUDE_METAL_SOURCES=1`` if you would like to
-include the sources for the Freedom Metal library in the generated standalone
-project. If this argument is not included, then the Freedom Metal library will
-be included in the generated project as a pre-built archive.
-
.. code-block:: bash
- make [PROGRAM=hello] [TARGET=sifive-hifive1] [INCLUDE_METAL_SOURCES=1] STANDALONE_DEST=/path/to/desired/location standalone
+ make [PROGRAM=hello] [TARGET=sifive-hifive1] STANDALONE_DEST=/path/to/desired/location standalone