Bug 15235 - Opening line in dev manual, "Unpacking Code" is potentially confusing
Summary: Opening line in dev manual, "Unpacking Code" is potentially confusing
Status: RESOLVED WORKSFORME
Alias: None
Product: Development Manual
Classification: Documentation
Component: development (show other bugs)
Version: unspecified
Hardware: All Multiple
: Medium normal
Target Milestone: 5.2
Assignee: Robert P. J. Day
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2023-10-12 11:53 UTC by Robert P. J. Day
Modified: 2025-05-15 18:27 UTC (History)
2 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Robert P. J. Day 2023-10-12 11:53:19 UTC

    
Comment 1 Robert P. J. Day 2023-10-12 11:56:35 UTC
Here, https://docs.yoctoproject.org/dev-manual/new-recipe.html#unpacking-code, the opening line:

"During the build, the do_unpack task unpacks the source with ${S} pointing to where it is unpacked."

could very easily be misinterpreted as suggesting that the variable S will be set automatically to where the code is unpacked, rather than making it clear that it is the recipe author's responsibility to set that variable to where the code is unpacked (if it is not the default location). This section can be much shorter and clearer.
Comment 2 Randy MacLeod 2024-05-23 15:26:50 UTC
Rob, could you just send a patch to see what people think of the new wording?
Comment 3 Randy MacLeod 2024-10-31 15:09:24 UTC
Bulk move of 5.1 bugs to 5.2. -- YP bug review (Randy)
Comment 4 Randy MacLeod 2025-05-15 18:27:35 UTC
I think that YP devs are aware of the abstractions that we use and
that this statement is not confusing unless you're really just getting started
with YP and if so, you have lots of other 'confusing' things to puzzle out.