mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
doc/advanced-build-system-tricks.md: add a doc for new variables
Add a documentation page for advanced low level tricks. Document the `RIOT_MAKEFILES_GLOBAL_PRE` and `RIOT_MAKEFILES_GLOBAL_POST`. I could not work around to have `$(RIOTBASE)/Makefile.include` in the doc as the `$()` part was removed, so I kept with `$RIOTBASE` for now.
This commit is contained in:
parent
efddd4aef9
commit
e47fea7bf5
@ -765,6 +765,7 @@ INPUT = ../../doc.txt \
|
||||
src/creating-modules.md \
|
||||
src/creating-an-application.md \
|
||||
src/getting-started.md \
|
||||
src/advanced-build-system-tricks.md \
|
||||
src/changelog.md \
|
||||
../../LOSTANDFOUND.md
|
||||
|
||||
|
40
doc/doxygen/src/advanced-build-system-tricks.md
Normal file
40
doc/doxygen/src/advanced-build-system-tricks.md
Normal file
@ -0,0 +1,40 @@
|
||||
Advanced build system tricks {#advanced-build-system-tricks}
|
||||
============================
|
||||
|
||||
[TOC]
|
||||
|
||||
Introduction {#introduction}
|
||||
============
|
||||
|
||||
This page describes some build systems tricks that can help developers but are
|
||||
not part of the standard workflow.
|
||||
|
||||
They are low level commands that should not be taken as part of a stable API
|
||||
but better have a documentation than only having a description in the build
|
||||
system code.
|
||||
|
||||
|
||||
Customize the build system {#customize-build-system}
|
||||
==========================
|
||||
|
||||
+ `RIOT_MAKEFILES_GLOBAL_PRE`: files parsed before the body of
|
||||
`$RIOTBASE/Makefile.include`
|
||||
+ `RIOT_MAKEFILES_GLOBAL_POST`: files parsed after the body of
|
||||
`$RIOTBASE/Makefile.include`
|
||||
|
||||
The variables are a list of files that will be included by
|
||||
`$RIOTBASE/Makefile.include`.
|
||||
They will be handled as relative to the application directory if the path is
|
||||
relative.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
You can configure your own files that will be parsed by the build system main
|
||||
`Makefile.include` file before or after its main body, examples usages can be:
|
||||
|
||||
* Globally overwrite a variable, like `TERMPROG`
|
||||
* Specify a hard written `PORT` / `DEBUG_ADAPTER_ID` for some BOARD values
|
||||
* Define your custom targets
|
||||
* Override default targets
|
@ -235,6 +235,7 @@ Further information {#further-information}
|
||||
- @ref getting-started
|
||||
- @ref creating-an-application
|
||||
- @ref creating-modules
|
||||
- @ref advanced-build-system-tricks
|
||||
|
||||
<!--
|
||||
Idea for this section: just name each of RIOT's main features/concepts and link
|
||||
|
Loading…
Reference in New Issue
Block a user