riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #14389 from aabadie/pr/doc/package_enh

Browse Source 
pkg/doc.txt: improve rendering of source location documentation
This commit is contained in:
Francisco 2020-06-30 15:13:52 +02:00 committed by GitHub
commit 59b58eaef2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
pkg/doc.txt
View File

@ -14,14 +14,23 @@
* INCLUDE += $(RIOTPKG)/<pkg_name>/... * INCLUDE += $(RIOTPKG)/<pkg_name>/...
* ~~~~~~~~ * ~~~~~~~~
* *
* When the package can be build out-of-source, the source code of external * When the package can be built out-of-source, the source code of external
* packages is fetched in a global location in * packages is fetched in a global location in:
* `$(RIOTBASE)/build/pkg/$(PKG_NAME)`. *
* ~~~~~~~~ {.mk}
* $(RIOTBASE)/build/pkg/$(PKG_NAME)
* ~~~~~~~~
*
* When out-of-source build is not possible (for example because the package * When out-of-source build is not possible (for example because the package
* build system doesn't allow it), the source code is fetch in the build * build system doesn't allow it), the source code is fetched in the build
* directory of the application under `$(BINDIR)/pkg/$(PKG_NAME)` * directory of the application under:
* and is the same as the build directory (this is the case for micropython *
* and openthread packages). * ~~~~~~~~ {.mk}
* $(BINDIR)/pkg/$(PKG_NAME)
* ~~~~~~~~
*
* In this case, the source and the build directory are the same (currently,
* this applies to the micropython and openthread packages).
* *
* Porting an external library * Porting an external library
* =========================== * ===========================