Results of latest documentation audit, May 2011


Scott Garman <scott.a.garman@...>
 

Hello,

As a data point for where we stand in ensuring our packages are producing documentation, I have some scripts which build all recipes (using the output of bitbake -s, not world), and then check that a -doc package is generated which is populated with files.

A summary of the results using yesterday's master are as follows:

591 recipes in total
308 recipes are building documentation
283 recipes are not building documentation

31 recipes did not build (and are counted as not building documentation above).

The lists of recipes are attached to this email. We'd like to improve the percentage of recipes that produce documentation (separated into -doc packages, of course) for our next major release in October.

Our userspace recipe maintainers should look into setting aside some time to know which of their recipes are in the "not building documentation" list and work to improve them. A lot of this is likely to be low-hanging fruit.

Thanks,

Scott

--
Scott Garman
Embedded Linux Engineer - Yocto Project
Intel Open Source Technology Center


Darren Hart <darren.hart@...>
 

On 05/06/2011 01:29 PM, Scott Garman wrote:
Hello,

As a data point for where we stand in ensuring our packages are
producing documentation, I have some scripts which build all recipes
(using the output of bitbake -s, not world), and then check that a -doc
package is generated which is populated with files.

A summary of the results using yesterday's master are as follows:

591 recipes in total
308 recipes are building documentation
283 recipes are not building documentation

31 recipes did not build (and are counted as not building documentation
above).

The lists of recipes are attached to this email. We'd like to improve
the percentage of recipes that produce documentation (separated into
-doc packages, of course) for our next major release in October.

Our userspace recipe maintainers should look into setting aside some
time to know which of their recipes are in the "not building
documentation" list and work to improve them. A lot of this is likely to
be low-hanging fruit.
I see "linux-*" in the list. What sort of documentation are we looking
for? The linux-image* packages in Ubuntu, for example, include a
changelog and a copyright.

Thanks,

--
Darren

Thanks,

Scott




_______________________________________________
yocto mailing list
yocto@...
https://lists.yoctoproject.org/listinfo/yocto

--
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel


Scott Garman <scott.a.garman@...>
 

On 05/06/2011 02:36 PM, Darren Hart wrote:
On 05/06/2011 01:29 PM, Scott Garman wrote:
Hello,

As a data point for where we stand in ensuring our packages are
producing documentation, I have some scripts which build all recipes
(using the output of bitbake -s, not world), and then check that a -doc
package is generated which is populated with files.

A summary of the results using yesterday's master are as follows:

591 recipes in total
308 recipes are building documentation
283 recipes are not building documentation

31 recipes did not build (and are counted as not building documentation
above).

The lists of recipes are attached to this email. We'd like to improve
the percentage of recipes that produce documentation (separated into
-doc packages, of course) for our next major release in October.

Our userspace recipe maintainers should look into setting aside some
time to know which of their recipes are in the "not building
documentation" list and work to improve them. A lot of this is likely to
be low-hanging fruit.
I see "linux-*" in the list. What sort of documentation are we looking
for? The linux-image* packages in Ubuntu, for example, include a
changelog and a copyright.
I'm not particularly concerned about the kernel packages. I think we can ignore it. I'll update my script to not report these recipes.

The main goal is to ensure that man pages and the like are being generated for userspace applications.

Scott

--
Scott Garman
Embedded Linux Engineer - Yocto Project
Intel Open Source Technology Center