diff mbox series

overview-manual: remove confusing and unnecessary paragraph about site.conf

Message ID 20220426204526.191666-1-michael.opdenacker@bootlin.com
State New
Headers show
Series overview-manual: remove confusing and unnecessary paragraph about site.conf | expand

Commit Message

Michael Opdenacker April 26, 2022, 8:45 p.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

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.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/overview-manual/concepts.rst | 14 ++------------
 1 file changed, 2 insertions(+), 12 deletions(-)
diff mbox series

Patch

diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 065d9586c6..441cd13bc3 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.
 
 The files ``site.conf`` and ``auto.conf`` are not created by the
 environment initialization script. If you want the ``site.conf`` file,
-you need to create that yourself. The ``auto.conf`` file is typically
+you need to create it yourself. The ``auto.conf`` file is typically
 created by an autobuilder:
 
 -  *site.conf:* You can use the ``conf/site.conf`` configuration
@@ -321,17 +321,7 @@  created by an autobuilder:
    you had several build environments and they shared some common
    features. You can set these default build properties here. A good
    example is perhaps the packaging format to use through the
-   :term:`PACKAGE_CLASSES`
-   variable.
-
-   One useful scenario for using the ``conf/site.conf`` file is to
-   extend your :term:`BBPATH` variable
-   to include the path to a ``conf/site.conf``. Then, when BitBake looks
-   for Metadata using :term:`BBPATH`, it finds the ``conf/site.conf`` file
-   and applies your common configurations found in the file. To override
-   configurations in a particular build directory, alter the similar
-   configurations within that build directory's ``conf/local.conf``
-   file.
+   :term:`PACKAGE_CLASSES` variable.
 
 -  *auto.conf:* The file is usually created and written to by an
    autobuilder. The settings put into the file are typically the same as