ee4b134dd6
Document this new build system feature. Since its purpose is customizing application builds, the logical place for the main body of documentation is in a new snippets/ directory in doc/build/. Create that directory and add its initial documentation. Like boards and samples, however, we expect people to write documentation for each snippet within the directory that defines the snippet itself. Therefore, add a new top-level snippets/ directory and stub out the documentation needed to document individual snippets as well. Add documentation and cross-references in other required places as well. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
26 lines
682 B
ReStructuredText
26 lines
682 B
ReStructuredText
.. _snippets:
|
|
|
|
Snippets
|
|
########
|
|
|
|
Snippets are a way to save build system settings in one place, and then use
|
|
those settings when you build any Zephyr application. This lets you save common
|
|
configuration separately when it applies to multiple different applications.
|
|
|
|
Some example use cases for snippets are:
|
|
|
|
- changing your board's console backend from a "real" UART to a USB CDC-ACM UART
|
|
- enabling frequently-used debugging options
|
|
- applying interrelated configuration settings to your "main" CPU and a
|
|
co-processor core on an AMP SoC
|
|
|
|
The following pages document this feature.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
using.rst
|
|
/snippets/index.rst
|
|
writing.rst
|
|
design.rst
|