RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

pkg/doc: Fix documentation on package header files

Browse Source
This commit is contained in:
Leandro Lanzieri 2022-01-19 10:15:52 +01:00
parent 74239561b8
commit e470a9ab57
No known key found for this signature in database
GPG Key ID: F4E9A721761C7593
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pkg/doc.txt
View File

@ -13,12 +13,10 @@
* Using packages
* ==============
* To add a package to the list of compiled modules you have to add it to the
* `USEPKG` macro in your application's Makefile. If the package provides
* header files you might need to update the `INCLUDE` macro, too:
* `USEPKG` macro in your application's Makefile:
*
* ~~~~~~~~ {.mk}
* USEPKG += <pkg_name>
* INCLUDE += $(RIOTPKG)/<pkg_name>/...
* ~~~~~~~~
*
* When the package can be built out-of-source, the source code of external
@ -53,6 +51,14 @@
* A rough template for several methods of acquiring a package is provided in
* `pkg/Makefile.git` and `pkg/Makefile.http`.
*
* If your port or the package provide header files, you need to update the
* `INCLUDES` variable in the package's `Makefile.include`:
*
* ~~~~~~~~ {.mk}
* INCLUDES += -I$(RIOTPKG)/<pkg_name>/include # headers provided by the port
* INCLUDES += -I$(PKGDIRBASE)/<pkg_name> # headers provided by the package
* ~~~~~~~~
*
* Patch files can be included in a `patches` directory in the package dir.
* These are applied to the upstream package to make it build with RIOT.
*