]> code.ossystems Code Review - openembedded-core.git/commit
bbvars.py: add a script to look for undocumented variables
authorDarren Hart <dvhart@linux.intel.com>
Tue, 11 Jan 2011 23:29:58 +0000 (15:29 -0800)
committerSaul Wold <sgw@linux.intel.com>
Wed, 12 Jan 2011 08:55:49 +0000 (00:55 -0800)
commite5e3fb23a2c5d8e40e4f751d804d9ea6fc3bfd2f
tree88a070e2e6c16605cd799987af9a1c87997606a6
parent514e59c780ac24439ae0839fab311d843841bf68
bbvars.py: add a script to look for undocumented variables

bbvars.py will compare recipes in meta directories with documentation files
and report on variables that don't appear to be documented. It reports the
number of times a variable is used as well as any doctags present in the
documentation config file.

The output of this is intended to aid in determining where documentation may
be lacking, but it is not perfect, and does generate some false positives. An
experienced eye and careful attention to count and doctag should be applied to
the results.

$ ./bbvars.py -d ../../documentation/poky-ref-manual/poky-ref-manual.html -m ../../meta -t ../../meta/conf/documentation.conf -T  | head -n 10
Found 1413 undocumented bb variables (out of 1578):
VARIABLE                              COUNT DOCTAG
===================================================
BUILD_ARCH                            4     The name of the building architecture. E.g. i686.
BUILD_CC_ARCH                         2     FIXME
BUILD_PREFIX                          4     FIXME
BUILD_SYS                             13    FIXME
BUILD_VENDOR                          2     FIXME
CACHE                                 1     The directory holding the cache of the metadata.
COMPATIBLE_HOST                       19    A regular expression which matches the HOST_SYS names supported by the package/file. Failure to match will cause the file to be skipped by the parser.

Signed-off-by: Darren Hart <dvhart@linux.intel.com>
CC: Richard Purdie <richard.purdie@linuxfoundation.org>
scripts/contrib/bbvars.py [new file with mode: 0755]