[RFC][PATCH] insane: configure option checking

[RFC][PATCH] insane: configure option checking

[Ross Burton]

Hi,

First: very much a RFC, this isn't ready for merging.  I thought I'd send it
before it got lost in a nest of branches.

This is a small sanity test I've been poking at in between builds to detect when
configure warns that it has been passed configure options it doesn't recongise.
It's got a whitelist for options such as --disable-silent-rules that are passed
blindly to large numbers of recipes, and I think we'll need the possibility of a
per-recipe whitelist in case they are required[1].

Comments/improvements welcome!

Ross

[1] The rationale here being the Xorg protocol recipes which have a common .inc
that disables all forms of documentation, but not every protocol recipe has all
forms enabled.

[PATCH] insane: configure option checking

[Ross Burton]

Signed-off-by: Ross Burton <ross.burton@intel.com>
---
 meta/classes/insane.bbclass |   19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/meta/classes/insane.bbclass b/meta/classes/insane.bbclass
index 524cdca..9809cba 100644
--- a/meta/classes/insane.bbclass
+++ b/meta/classes/insane.bbclass
@@ -919,6 +919,25 @@ Missing inherit gettext?""" % (gt, config))
     if not package_qa_check_license(workdir, d):
         bb.fatal("Licensing Error: LIC_FILES_CHKSUM does not match, please fix")
 
+    ###########################################################################
+    # Check unrecognised configure options (with a white list)
+    ###########################################################################
+    if bb.data.inherits_class("autotools", d):
+        bb.note("Checking configure output for unrecognised options")
+        try:
+            flag = "WARNING: unrecognized options:"
+            log = os.path.join(d.getVar('B', True), 'config.log')
+            output = subprocess.check_output(['grep', '-F', flag, log])
+            options = set(map(lambda s: s.strip(' ,'), output.partition(flag)[2].split()))
+            whitelist = {'--enable-nls', '--disable-nls', '--disable-silent-rules', '--disable-dependency-tracking', '--with-libtool-sysroot'}
+            # TODO: allow additions per-recipe?
+            options -= whitelist
+            if options:
+		pn = d.getVar('PN', True)
+                error_msg = pn + ": configure was passed unrecognised options: " + " ".join(options)
+                package_qa_handle_error("unknown-configure-option", error_msg, d)
+        except subprocess.CalledProcessError:
+            pass
 }
 # The Staging Func, to check all staging
 #addtask qa_staging after do_populate_sysroot before do_build
-- 
1.7.10.4

Re: [RFC][PATCH] insane: configure option checking

[Martin Jansa]

[-- Attachment #1: Type: text/plain, Size: 720 bytes --]

On Thu, Sep 05, 2013 at 02:55:20PM +0100, Ross Burton wrote:
> Hi,
> 
> First: very much a RFC, this isn't ready for merging.  I thought I'd send it
> before it got lost in a nest of branches.
> 
> This is a small sanity test I've been poking at in between builds to detect when
> configure warns that it has been passed configure options it doesn't recongise.
> It's got a whitelist for options such as --disable-silent-rules that are passed
> blindly to large numbers of recipes, and I think we'll need the possibility of a
> per-recipe whitelist in case they are required[1].
> 
> Comments/improvements welcome!

I like this idea a lot :)

-- 
Martin 'JaMa' Jansa     jabber: Martin.Jansa@gmail.com

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 205 bytes --]

[RFC][PATCH] insane: configure option checking

[Ross Burton]

Hi,

This is v2 of my unrecognised-configure-options sanity test, that checks for
warnings at the end of configure logs and will emit a warning if there are
unrecognised options.  Useful to detect typos or options that have been
removed/renamed.

V2 differs from V1 in that the whitelist can be extended, and defaults to the
options commonly used in oe-core classes.

As an example of extending it, xorg-proto-common.inc in my branch has this:

+UNKNOWN_CONFIGURE_WHITELIST += "--without-fop --without-xmlto"

I've also done a full build of core-image-sato with this test enabled, this was
the output earlier today: http://pastebin.com/7LCZF55Z.  Between some local
whitelist patches and the patches I just sent, that list has almost halved in
size.

Any thoughts, or does this look good to go?

Ross