* [RFC 1/3] ref-manual: simplify SRC_URI reference
2021-11-05 15:11 [PATCH 0/3] Simplify variable reference descriptions Michael Opdenacker
@ 2021-11-05 15:11 ` Michael Opdenacker
2021-11-05 15:11 ` [RFC 2/3] ref-manual: move TMPDIR to BitBake's documentation Michael Opdenacker
2021-11-05 15:11 ` [RFC 3/3] ref-manual: move TOPDIR to BitBake's manual Michael Opdenacker
2 siblings, 0 replies; 4+ messages in thread
From: Michael Opdenacker @ 2021-11-05 15:11 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
Moving all the features that also apply to BitBake
to the BitBake manual.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/ref-manual/variables.rst | 122 ++-----------------------
1 file changed, 8 insertions(+), 114 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 9eea8081c7..441a10929e 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7016,88 +7016,11 @@ system and gives an overview of their function and contents.
for additional information.
:term:`SRC_URI`
- The list of source files - local or remote. This variable tells the
- OpenEmbedded build system which bits to pull in for the build and how
- to pull them in. For example, if the recipe or append file only needs
- to fetch a tarball from the Internet, the recipe or append file uses
- a single :term:`SRC_URI` entry. On the other hand, if the recipe or
- append file needs to fetch a tarball, apply two patches, and include
- a custom file, the recipe or append file would include four instances
- of the variable.
-
- The following list explains the available URI protocols. URI
- protocols are highly dependent on particular BitBake Fetcher
- submodules. Depending on the fetcher BitBake uses, various URL
- parameters are employed. For specifics on the supported Fetchers, see
- the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers`" section in the
- BitBake User Manual.
-
- - ``file://`` - Fetches files, which are usually files shipped
- with the :term:`Metadata`, from the local machine (e.g.
- :ref:`patch <overview-manual/concepts:patching>` files).
- The path is relative to the :term:`FILESPATH`
- variable. Thus, the build system searches, in order, from the
- following directories, which are assumed to be a subdirectories of
- the directory in which the recipe file (``.bb``) or append file
- (``.bbappend``) resides:
-
- - ``${BPN}`` - The base recipe name without any special suffix
- or version numbers.
-
- - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and
- version but without any special package name suffix.
-
- - *files -* Files within a directory, which is named ``files``
- and is also alongside the recipe or append file.
- .. note::
-
- If you want the build system to pick up files specified through
- a
- SRC_URI
- statement from your append file, you need to be sure to extend
- the
- FILESPATH
- variable by also using the
- FILESEXTRAPATHS
- variable from within your append file.
-
- - ``bzr://`` - Fetches files from a Bazaar revision control
- repository.
-
- - ``git://`` - Fetches files from a Git revision control
- repository.
-
- - ``osc://`` - Fetches files from an OSC (openSUSE Build service)
- revision control repository.
-
- - ``repo://`` - Fetches files from a repo (Git) repository.
-
- - ``ccrc://`` - Fetches files from a ClearCase repository.
-
- - ``http://`` - Fetches files from the Internet using ``http``.
-
- - ``https://`` - Fetches files from the Internet using ``https``.
-
- - ``ftp://`` - Fetches files from the Internet using ``ftp``.
-
- - ``cvs://`` - Fetches files from a CVS revision control
- repository.
-
- - ``hg://`` - Fetches files from a Mercurial (``hg``) revision
- control repository.
-
- - ``p4://`` - Fetches files from a Perforce (``p4``) revision
- control repository.
+ See the BitBake manual for the initial description for this variable:
+ :term:`bitbake:SRC_URI`
- - ``ssh://`` - Fetches files from a secure shell.
-
- - ``svn://`` - Fetches files from a Subversion (``svn``) revision
- control repository.
-
- - ``npm://`` - Fetches JavaScript modules from a registry.
-
- - ``az://`` - Fetches files from an Azure Storage account.
+ The following features are added by OpenEmbedded and the Yocto Project.
There are standard and recipe-specific options for :term:`SRC_URI`. Here are
standard ones:
@@ -7133,41 +7056,12 @@ system and gives an overview of their function and contents.
- ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to
``rev``.
- Here are some additional options worth mentioning:
-
- - ``unpack`` - Controls whether or not to unpack the file if it is
- an archive. The default action is to unpack the file.
-
- - ``destsuffix`` - Places the file (or extracts its contents) into
- the specified subdirectory of :term:`WORKDIR` when
- the Git fetcher is used.
-
- - ``subdir`` - Places the file (or extracts its contents) into the
- specified subdirectory of :term:`WORKDIR` when the local (``file://``)
- fetcher is used.
-
- - ``localdir`` - Places the file (or extracts its contents) into
- the specified subdirectory of :term:`WORKDIR` when the CVS fetcher is
- used.
-
- - ``subpath`` - Limits the checkout to a specific subpath of the
- tree when using the Git fetcher is used.
-
- - ``name`` - Specifies a name to be used for association with
- :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one
- file or git repository specified in :term:`SRC_URI`. For example::
-
- SRC_URI = "git://example.com/foo.git;name=first \
- git://example.com/bar.git;name=second \
- http://example.com/file.tar.gz;name=third"
-
- SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15"
- SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f"
- SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
-
+ .. note::
- - ``downloadfilename`` - Specifies the filename used when storing
- the downloaded file.
+ If you want the build system to pick up files specified through
+ a :term:`SRC_URI` statement from your append file, you need to be
+ sure to extend the :term:`FILESPATH` variable by also using the
+ :term:`FILESEXTRAPATHS` variable from within your append file.
:term:`SRC_URI_OVERRIDES_PACKAGE_ARCH`
By default, the OpenEmbedded build system automatically detects
--
2.25.1
^ permalink raw reply related [flat|nested] 4+ messages in thread* [RFC 2/3] ref-manual: move TMPDIR to BitBake's documentation
2021-11-05 15:11 [PATCH 0/3] Simplify variable reference descriptions Michael Opdenacker
2021-11-05 15:11 ` [RFC 1/3] ref-manual: simplify SRC_URI reference Michael Opdenacker
@ 2021-11-05 15:11 ` Michael Opdenacker
2021-11-05 15:11 ` [RFC 3/3] ref-manual: move TOPDIR to BitBake's manual Michael Opdenacker
2 siblings, 0 replies; 4+ messages in thread
From: Michael Opdenacker @ 2021-11-05 15:11 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
As it is not specific to OE / Yocto Project
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/ref-manual/variables.rst | 21 ---------------------
1 file changed, 21 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 441a10929e..44fccd5322 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8022,27 +8022,6 @@ system and gives an overview of their function and contents.
and second (HMS) format (e.g. "140159" for one minute and fifty-nine
seconds past 1400 hours).
- :term:`TMPDIR`
- This variable is the base directory the OpenEmbedded build system
- uses for all build output and intermediate files (other than the
- shared state cache). By default, the :term:`TMPDIR` variable points to
- ``tmp`` within the :term:`Build Directory`.
-
- If you want to establish this directory in a location other than the
- default, you can uncomment and edit the following statement in the
- ``conf/local.conf`` file in the :term:`Source Directory`::
-
- #TMPDIR = "${TOPDIR}/tmp"
-
- An example use for this scenario is to set :term:`TMPDIR` to a local disk,
- which does not use NFS, while having the Build Directory use NFS.
-
- The filesystem used by :term:`TMPDIR` must have standard filesystem
- semantics (i.e. mixed-case files are unique, POSIX file locking, and
- persistent inodes). Due to various issues with NFS and bugs in some
- implementations, NFS does not meet this minimum requirement.
- Consequently, :term:`TMPDIR` cannot be on NFS.
-
:term:`TOOLCHAIN_HOST_TASK`
This variable lists packages the OpenEmbedded build system uses when
building an SDK, which contains a cross-development environment. The
--
2.25.1
^ permalink raw reply related [flat|nested] 4+ messages in thread