| Summary: | Opening line in dev manual, "Unpacking Code" is potentially confusing | ||
|---|---|---|---|
| Product: | [Documentation] Development Manual | Reporter: | Robert P. J. Day <rpjday> |
| Component: | development | Assignee: | Robert P. J. Day <rpjday> |
| Status: | RESOLVED WORKSFORME | QA Contact: | |
| Severity: | normal | ||
| Priority: | Medium | CC: | michael.opdenacker, randy.macleod |
| Version: | unspecified | ||
| Target Milestone: | 5.2 | ||
| Hardware: | All | ||
| OS: | Multiple | ||
| Whiteboard: | |||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Yes (doc changes required) | |
|
Description
Robert P. J. Day
2023-10-12 11:53:19 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. Rob, could you just send a patch to see what people think of the new wording? Bulk move of 5.1 bugs to 5.2. -- YP bug review (Randy) 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. |