SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix description of bblayers_conf_header and local_conf_header

Browse Source 
For a long time already (c9326cc1ed), the documentation suggests a
different ordering of entries generated by *_conf_header than we
actually create. Finally fix this.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Jan Kiszka 2023-02-01 08:54:06 +01:00
parent b27ab659f3
commit 795ecdbcd6
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/userguide.rst
View File

@ -463,8 +463,9 @@ Configuration reference
A string that is added to the ``bblayers.conf``. The entry id A string that is added to the ``bblayers.conf``. The entry id
(``<bblayers-conf-id>``) should be unique if lines should be added and (``<bblayers-conf-id>``) should be unique if lines should be added and
can be the same from another included file, if this entry should be can be the same from another included file, if this entry should be
overwritten. The lines are added to ``bblayers.conf`` in the same order overwritten. The lines are added to ``bblayers.conf`` in alphabetic order
as they are included from the different configuration files. of ``<bblayers-conf-id>`` to ensure deterministic generation of config
files.
* ``local_conf_header``: dict [optional] * ``local_conf_header``: dict [optional]
This contains strings that should be added to the ``local.conf``. This contains strings that should be added to the ``local.conf``.