poky/scripts
Darren Hart e5e3fb23a2 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>
2011-01-12 00:55:49 -08:00
..
contrib bbvars.py: add a script to look for undocumented variables 2011-01-12 00:55:49 -08:00
jhbuild Rename rewrite.py to jhbuild2oe.py. 2006-08-10 06:43:09 +00:00
qemuimage-tests qemuimagetest: Remove connman test for lsb image and fix one warning in Test_Create_Qemu 2011-01-06 10:06:32 +00:00
bitbake scripts/bitbake: Skip building pseudo if necessary. 2011-01-05 14:24:00 +00:00
creat-lsb-image creat-lsb-image: download lsb test suite and creat a image with lsb test suite 2010-12-10 22:01:40 -08:00
create-pull-request git-pull: add the new create-pull-request script 2010-11-10 21:22:27 +08:00
gen-site-config siteconfig: generate configuration data caches for autoconf 2010-09-03 10:50:02 +01:00
poky-addptable2image Use /sbin/fdisk because not all systems has /sbin in PATH 2008-05-14 12:57:11 +00:00
poky-env-internal poky-init-build-env: Enable all POSIX shells 2010-12-20 23:00:51 +00:00
poky-export-rootfs Update meta-ide-support dependencies 2010-10-07 22:07:45 +01:00
poky-extract-sdk scripts: use the exported POKY_NATIVE_SYSROOT variable 2010-09-07 11:22:54 +01:00
poky-find-native-sysroot Make poky-qemu and related scripts work with arbitrary SDK locations 2010-12-09 15:00:45 +00:00
poky-gen-tapdevs poky-gen-tapdevs: script to create a 'bank' of tap interfaces 2010-10-07 19:53:46 +01:00
poky-git-proxy-command scripts: Add git proxy script 2008-04-08 11:31:08 +00:00
poky-git-proxy-socks-command scripts/build: Update the git proxy setup instructions 2008-10-23 15:12:41 +01:00
poky-git-proxy-socks.c scripts/build: Update the git proxy setup instructions 2008-10-23 15:12:41 +01:00
poky-nokia800-flashutil poky-nokia800-flashutil: merged offsets from Andrew script and added Diablo notes 2008-08-08 07:41:33 +00:00
poky-qemu qemu: Add some checks before enabling KVM 2010-12-23 14:28:22 +00:00
poky-qemu-ifdown Make poky-qemu and related scripts work with arbitrary SDK locations 2010-12-09 15:00:45 +00:00
poky-qemu-ifup Make poky-qemu and related scripts work with arbitrary SDK locations 2010-12-09 15:00:45 +00:00
poky-qemu-internal Add extra parameters options for poky-qemu scripts 2010-12-16 15:53:09 +00:00
poky-qemu.README poky-qemu.README: Minor updates 2008-05-22 08:22:47 +00:00
poky-setup-builddir poky-init-build-env: Breakup the environment script 2010-12-20 23:00:25 +00:00
poky-trim-schemas Add poky-trim-schemas post install script to remove unneeded schema locale translations from images (credit to Ross Burton for the initial script) 2009-08-28 17:11:57 +01:00
pstage-scanner Enable build dir outside of the poky directory 2010-07-21 15:39:53 +01:00
qemuimage-testlib qemuimagetest: Remove connman test for lsb image and fix one warning in Test_Create_Qemu 2011-01-06 10:06:32 +00:00
README Added scripts dir 2006-07-28 19:47:37 +00:00
rootfs_rpm-extract-postinst.awk meta/classes/rootfs_rpm.bbclass: re implement base on rpm5 2010-07-24 00:46:57 +01:00
send-pull-request send-pull-request: allow users to select git-send-email or sendmail 2010-12-23 14:20:50 +00:00

This directory contains Various useful scripts for working with poky