diff mbox series

ref-manual: variables.rst: refer to BBPATH in the BitBake User Manual

Message ID 20220922075600.1160944-1-michael.opdenacker@bootlin.com
State New
Headers show
Series ref-manual: variables.rst: refer to BBPATH in the BitBake User Manual | expand

Commit Message

Michael Opdenacker Sept. 22, 2022, 7:56 a.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

As reported in [YOCTO #14502], the description of BBPATH in the
Yocto Project Manual is redundant with its description in the
BitBake User Manual.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss@0leil.net>

---

Without this redirection, the references to BBPATH would still
work, as it this the case for terms only definited in the BitBake
User Manual, but BBPATH would no longer appear in the variable index.

This would probably be a bad thing.
---
 documentation/ref-manual/variables.rst | 15 +--------------
 1 file changed, 1 insertion(+), 14 deletions(-)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index fe845bf375..f6cc66e2c4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -729,20 +729,7 @@  system and gives an overview of their function and contents.
       section in the Yocto Project Development Tasks Manual.
 
    :term:`BBPATH`
-      Used by BitBake to locate ``.bbclass`` and configuration files. This
-      variable is analogous to the ``PATH`` variable.
-
-      .. note::
-
-         If you run BitBake from a directory outside of the
-         :term:`Build Directory`, you must be sure to set :term:`BBPATH`
-         to point to the Build Directory. Set the variable as you would any
-         environment variable and then run BitBake::
-
-                 $ BBPATH = "build_directory"
-                 $ export BBPATH
-                 $ bitbake target
-
+      See :term:`bitbake:BBPATH` in the BitBake User Manual.
 
    :term:`BBSERVER`
       If defined in the BitBake environment, :term:`BBSERVER` points to the