diff options
| author | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-02-13 10:22:14 -0800 |
|---|---|---|
| committer | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-02-13 10:39:15 -0800 |
| commit | cb8873379bd03d84352a6d28e985ab975b555dbb (patch) | |
| tree | 11e63b32f59c955f17f2f497933795c4fd69bfc0 | |
| parent | 742360812845743f6eb67813fbb97ee60029c45c (diff) | |
Document INCLUDE_METAL_SOURCES for standalone target
Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
| -rw-r--r-- | Makefile | 3 | ||||
| -rw-r--r-- | README.md | 7 | ||||
| -rw-r--r-- | doc/sphinx/userguide/standalone.rst | 7 |
3 files changed, 14 insertions, 3 deletions
@@ -98,7 +98,8 @@ help: @echo " Launch OpenOCD and attach GDB to the running program." @echo "" @echo " standalone BSP=metal STANDALONE_DEST=/path/to/desired/location" - @echo " [PROGRAM=$(PROGRAM) TARGET=$(TARGET)]:" + @echo " [INCLUDE_METAL_SOURCES=1] [PROGRAM=$(PROGRAM)]" + @echo " [TARGET=$(TARGET)]:" @echo " Export a program for a single target into a standalone" @echo " project directory at STANDALONE_DEST." @echo "" @@ -248,8 +248,13 @@ 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. + ``` -make BSP=metal [PROGRAM=hello] [TARGET=sifive-hifive1] STANDALONE_DEST=/path/to/desired/location standalone +make BSP=metal [PROGRAM=hello] [TARGET=sifive-hifive1] [INCLUDE_METAL_SOURCES=1] STANDALONE_DEST=/path/to/desired/location standalone ``` Run `make help` for more commands. diff --git a/doc/sphinx/userguide/standalone.rst b/doc/sphinx/userguide/standalone.rst index 58f7f51..61214d2 100644 --- a/doc/sphinx/userguide/standalone.rst +++ b/doc/sphinx/userguide/standalone.rst @@ -8,7 +8,12 @@ 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 BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] STANDALONE_DEST=/path/to/desired/location standalone + make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] [INCLUDE_METAL_SOURCES=1] STANDALONE_DEST=/path/to/desired/location standalone |