diff mbox series

[4/4] doc: update manual to reflect bb.fetch2 => bb.fetch migration

Message ID 20260827142958.547182-4-chris.laplante@agilent.com
State New
Headers show
Series [1/4] lib: rename fetch2 as fetch; invert compat shim to make bb.fetch2 = bb.fetch | expand

Commit Message

chris.laplante@agilent.com Aug. 27, 2026, 2:29 p.m. UTC 
From: Chris Laplante <chris.laplante@agilent.com>

AI-Generated: GPT-5.6 Sol

Signed-off-by: Chris Laplante <chris.laplante@agilent.com>
---
 .../bitbake-user-manual-fetching.rst                  | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index b96018a4e..d326403fa 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -11,10 +11,11 @@  with the intricacies of downloading source code and files from remote
 systems. Fetching source code is one of the cornerstones of building
 software. As such, this module forms an important part of BitBake.
 
-The current fetch module is called "fetch2" and refers to the fact that
-it is the second major version of the API. The original version is
-obsolete and has been removed from the codebase. Thus, in all cases,
-"fetch" refers to "fetch2" in this manual.
+The fetch module was previously called ``fetch2`` to distinguish the second
+major version of the API from the original version, which is obsolete and has
+been removed from the codebase. The module has since been renamed back to
+``fetch``. Existing code using ``bb.fetch2`` remains supported by a
+compatibility alias, but new code should use ``bb.fetch``.
 
 The Download (Fetch)
 ====================
@@ -30,7 +31,7 @@  The code to execute the first part of this process, a fetch, looks
 something like the following::
 
    src_uri = (d.getVar('SRC_URI') or "").split()
-   fetcher = bb.fetch2.Fetch(src_uri, d)
+   fetcher = bb.fetch.Fetch(src_uri, d)
    fetcher.download()
 
 This code sets up an instance of the fetch class. The instance uses a