Bug 14515

Summary: Some distro features missing from documentation
Product: [Documentation] Reference Reporter: Frans Meulenbroeks <fransmeulenbroeks>
Component: handbookAssignee: Michael Opdenacker <michael.opdenacker>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: Medium CC: jdelbe.foss, poky.doc.watcher, poky.watcher, randy.macleod
Version: unspecified   
Target Milestone: 4.2 M1   
Hardware: x86   
OS: Multiple   
Whiteboard:
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Frans Meulenbroeks 2021-08-18 05:43:49 UTC
Some distro features are not documented.

E.g. poky/meta/conf/distro/include/default-distrovars.inc contains
DISTRO_FEATURES_DEFAULT ?= "acl alsa argp bluetooth ext2 ipv4 ipv6 largefile pcmcia usbgadget usbhost wifi xattr nfs zeroconf pci 3g nfc x11 vfat"

However the reference manual ch 12.2 does not describe the following from that list:
acl
argp
ipv4
largefile
xattr
zeeroconf
3g
nfc
vfat

It might be that more ditro features are missing from the manual.
I did not verify if all features that are mentioned in 12.2 are indeed still all there, but it might be worthwhile to check those too.
Comment 1 Randy MacLeod 2021-08-19 14:46:53 UTC
We could document the DFs that is used in oe-core.
Documenting that a complete list of DFs is not in scope since other layers can add distro features. Please note this in the manual to help people understand.
Comment 2 Michael Opdenacker 2022-09-21 15:06:02 UTC
Why not adding the distro features defined in Poky too?

meta-poky/conf/distro/poky.conf:POKY_DEFAULT_DISTRO_FEATURES = "largefile opengl ptest multiarch wayland vulkan"
meta-poky/conf/distro/poky.conf:DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${POKY_DEFAULT_DISTRO_FEATURES}"
Comment 3 Michael Opdenacker 2022-09-21 20:27:49 UTC
Posted a patch to address this issue:
https://lists.yoctoproject.org/g/docs/message/3201
Comment 4 Michael Opdenacker 2022-10-06 07:49:40 UTC
Now fixed in master:
https://git.yoctoproject.org/yocto-docs/commit/?id=0db0560a7906b75eaa1b611092ad0f6444fb2fc6
Comment 5 Julien Delbergue 2023-03-22 11:57:07 UTC
"argp" seems to be still missing from the documentation.
A small description would be helpful, as I am not sure what the feature brings. Thanks!
Comment 6 Michael Opdenacker 2023-03-22 16:35:51 UTC
Good catch!
I asked the question on the Poky mailing list:
https://lists.yoctoproject.org/g/poky/message/13042
Comment 7 Michael Opdenacker 2023-03-22 17:13:54 UTC
argp is no longer in use, not even in the "kirkstone" branch of Poky (and apparently not even in "dunfell".
No need to document "argp" then.
Thanks anyway for asking!