Bug 14508 - Add references to classes, tasks and variables
Summary: Add references to classes, tasks and variables
Status: RESOLVED FIXED
Alias: None
Product: General Docs
Classification: Documentation
Component: docs-general (show other bugs)
Version: 3.3
Hardware: x86 Multiple
: Medium+ normal
Target Milestone: 4.2 M1
Assignee: Michael Opdenacker
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2021-08-13 08:42 UTC by Michael Opdenacker
Modified: 2023-01-02 13:35 UTC (History)
3 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 Michael Opdenacker 2021-08-13 08:42:54 UTC
There are places in the documentation where we are currently lacking proper references to classes, tasks and variables defined elsewhere in the manuals.

For example:
  s/``do_fetch``/:ref:`ref-tasks-fetch`/
  s/``do_install``/:ref:`ref-tasks-install`/
  ... etc. for all the standard tasks

Without those, some of our scripts have missed some definitions.
Credits to Quentin Schulz for highlighting this need.
Comment 1 Michael Opdenacker 2022-09-23 18:35:33 UTC
I sent a patch series to address at least the missing links to tasks:
https://lore.kernel.org/yocto-docs/20220923175219.6652-1-michael.opdenacker@bootlin.com/T/#t
Comment 3 Michael Opdenacker 2022-12-07 20:42:32 UTC
Sent a 3rd series adding missing references to variables:
https://lists.yoctoproject.org/g/docs/message/3521
Comment 4 Michael Opdenacker 2023-01-02 13:35:45 UTC
Now fixes thanks to this final commit:
https://git.yoctoproject.org/yocto-docs/commit/?id=7878a21be8fb6c7a1ab88ae44aa5f7bf0079391a