summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-04-26 19:44:20 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-05-10 12:52:35 +0100
commit771d574a40ec8be32b5af9c031bddcaa2001716a (patch)
treee780a345aede024a7d49726a498a0c95e71e29fc /documentation/overview-manual
parent76ae67731364a8e77fadab500b845545d7776dfc (diff)
downloadpoky-771d574a40ec8be32b5af9c031bddcaa2001716a.tar.gz
overview-manual: remove confusing and unnecessary paragraph about site.conf
The explanations which precede and follow are sufficient. The removed text seemed to suggest to use conf/site.conf to specify the location of another conf/site.conf file. Another issue was that the way to override conf/site.conf settings through conf/local.conf was described before explaining that conf/site.conf is processed before conf/local.conf. (From yocto-docs rev: d477a2044e7b53977daf4d0c0d45cad29c2006fb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
-rw-r--r--documentation/overview-manual/concepts.rst14
1 files changed, 2 insertions, 12 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 7b056acc87..93437856d9 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -313,7 +313,7 @@ section in the Yocto Project Development Tasks Manual.
313 313
314The files ``site.conf`` and ``auto.conf`` are not created by the 314The files ``site.conf`` and ``auto.conf`` are not created by the
315environment initialization script. If you want the ``site.conf`` file, 315environment initialization script. If you want the ``site.conf`` file,
316you need to create that yourself. The ``auto.conf`` file is typically 316you need to create it yourself. The ``auto.conf`` file is typically
317created by an autobuilder: 317created by an autobuilder:
318 318
319- *site.conf:* You can use the ``conf/site.conf`` configuration 319- *site.conf:* You can use the ``conf/site.conf`` configuration
@@ -321,17 +321,7 @@ created by an autobuilder:
321 you had several build environments and they shared some common 321 you had several build environments and they shared some common
322 features. You can set these default build properties here. A good 322 features. You can set these default build properties here. A good
323 example is perhaps the packaging format to use through the 323 example is perhaps the packaging format to use through the
324 :term:`PACKAGE_CLASSES` 324 :term:`PACKAGE_CLASSES` variable.
325 variable.
326
327 One useful scenario for using the ``conf/site.conf`` file is to
328 extend your :term:`BBPATH` variable
329 to include the path to a ``conf/site.conf``. Then, when BitBake looks
330 for Metadata using :term:`BBPATH`, it finds the ``conf/site.conf`` file
331 and applies your common configurations found in the file. To override
332 configurations in a particular build directory, alter the similar
333 configurations within that build directory's ``conf/local.conf``
334 file.
335 325
336- *auto.conf:* The file is usually created and written to by an 326- *auto.conf:* The file is usually created and written to by an
337 autobuilder. The settings put into the file are typically the same as 327 autobuilder. The settings put into the file are typically the same as