diff options
| author | Alexander Kanavin <alex@linutronix.de> | 2025-06-23 14:42:07 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-06-26 11:02:55 +0100 |
| commit | 6c424ef64a2a38f8b09273f2d212a3b212edc405 (patch) | |
| tree | b8433c6d65e6b44b33e97881f821e828da0d14c3 /bitbake | |
| parent | 43339218961079edc477e8c54a6b90423a88e4c9 (diff) | |
| download | poky-6c424ef64a2a38f8b09273f2d212a3b212edc405.tar.gz | |
bitbake: bitbake-user-manual: correctly reference UNPACKDIR when describing unpacking
Also, drop an obsolete S = WORKDIR/git note.
(Bitbake rev: 3884b386cda649030f59e3040dd08e6aa2ec50cf)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake')
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | 21 |
1 files changed, 7 insertions, 14 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst index eac3cbdfb5..a2c2432db1 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst | |||
| @@ -39,10 +39,10 @@ variable and then calls the ``download`` method to download the files. | |||
| 39 | 39 | ||
| 40 | The instantiation of the fetch class is usually followed by:: | 40 | The instantiation of the fetch class is usually followed by:: |
| 41 | 41 | ||
| 42 | rootdir = l.getVar('WORKDIR') | 42 | rootdir = l.getVar('UNPACKDIR') |
| 43 | fetcher.unpack(rootdir) | 43 | fetcher.unpack(rootdir) |
| 44 | 44 | ||
| 45 | This code unpacks the downloaded files to the specified by ``WORKDIR``. | 45 | This code unpacks the downloaded files to the specified by ``UNPACKDIR``. |
| 46 | 46 | ||
| 47 | .. note:: | 47 | .. note:: |
| 48 | 48 | ||
| @@ -51,7 +51,7 @@ This code unpacks the downloaded files to the specified by ``WORKDIR``. | |||
| 51 | examine the OpenEmbedded class file ``base.bbclass`` | 51 | examine the OpenEmbedded class file ``base.bbclass`` |
| 52 | . | 52 | . |
| 53 | 53 | ||
| 54 | The :term:`SRC_URI` and ``WORKDIR`` variables are not hardcoded into the | 54 | The :term:`SRC_URI` and ``UNPACKDIR`` variables are not hardcoded into the |
| 55 | fetcher, since those fetcher methods can be (and are) called with | 55 | fetcher, since those fetcher methods can be (and are) called with |
| 56 | different variable names. In OpenEmbedded for example, the shared state | 56 | different variable names. In OpenEmbedded for example, the shared state |
| 57 | (sstate) code uses the fetch module to fetch the sstate files. | 57 | (sstate) code uses the fetch module to fetch the sstate files. |
| @@ -463,13 +463,6 @@ Here are some example URLs:: | |||
| 463 | 463 | ||
| 464 | .. note:: | 464 | .. note:: |
| 465 | 465 | ||
| 466 | When using ``git`` as the fetcher of the main source code of your software, | ||
| 467 | ``S`` should be set accordingly:: | ||
| 468 | |||
| 469 | S = "${WORKDIR}/git" | ||
| 470 | |||
| 471 | .. note:: | ||
| 472 | |||
| 473 | Specifying passwords directly in ``git://`` urls is not supported. | 466 | Specifying passwords directly in ``git://`` urls is not supported. |
| 474 | There are several reasons: :term:`SRC_URI` is often written out to logs and | 467 | There are several reasons: :term:`SRC_URI` is often written out to logs and |
| 475 | other places, and that could easily leak passwords; it is also all too | 468 | other places, and that could easily leak passwords; it is also all too |
| @@ -598,7 +591,7 @@ and port, username, and password, and fetches the Head Revision:: | |||
| 598 | SRC_URI = "p4://example-depot/main/source/..." | 591 | SRC_URI = "p4://example-depot/main/source/..." |
| 599 | SRCREV = "${AUTOREV}" | 592 | SRCREV = "${AUTOREV}" |
| 600 | PV = "p4-${SRCPV}" | 593 | PV = "p4-${SRCPV}" |
| 601 | S = "${WORKDIR}/p4" | 594 | S = "${UNPACKDIR}/p4" |
| 602 | 595 | ||
| 603 | Here is an example that specifies the server URL and port, username, and | 596 | Here is an example that specifies the server URL and port, username, and |
| 604 | password, and fetches a Revision based on a Label:: | 597 | password, and fetches a Revision based on a Label:: |
| @@ -607,15 +600,15 @@ password, and fetches a Revision based on a Label:: | |||
| 607 | SRC_URI = "p4://user:passwd@example-depot/main/source/..." | 600 | SRC_URI = "p4://user:passwd@example-depot/main/source/..." |
| 608 | SRCREV = "release-1.0" | 601 | SRCREV = "release-1.0" |
| 609 | PV = "p4-${SRCPV}" | 602 | PV = "p4-${SRCPV}" |
| 610 | S = "${WORKDIR}/p4" | 603 | S = "${UNPACKDIR}/p4" |
| 611 | 604 | ||
| 612 | .. note:: | 605 | .. note:: |
| 613 | 606 | ||
| 614 | You should always set S to "${WORKDIR}/p4" in your recipe. | 607 | You should always set S to "${UNPACKDIR}/p4" in your recipe. |
| 615 | 608 | ||
| 616 | By default, the fetcher strips the depot location from the local file paths. In | 609 | By default, the fetcher strips the depot location from the local file paths. In |
| 617 | the above example, the content of ``example-depot/main/source/`` will be placed | 610 | the above example, the content of ``example-depot/main/source/`` will be placed |
| 618 | in ``${WORKDIR}/p4``. For situations where preserving parts of the remote depot | 611 | in ``${UNPACKDIR}/p4``. For situations where preserving parts of the remote depot |
| 619 | paths locally is desirable, the fetcher supports two parameters: | 612 | paths locally is desirable, the fetcher supports two parameters: |
| 620 | 613 | ||
| 621 | - *"module":* | 614 | - *"module":* |
