Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/fatalInheritance into lp:ubuntu-ui-toolkit/staging

[Cris Dywan]

Fail doc generation on missing \inherits tags

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1967
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/1185/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6288/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/1185/rebuild

review: Needs Fixing (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

PASSED: Continuous integration, rev:1967
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/1151/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6293/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/1151/rebuild

review: Approve (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1967
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/1401/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6294/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/1401/rebuild

review: Needs Fixing (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1967
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/1394/
Executed test runs:
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6295/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/1394/rebuild

review: Needs Fixing (continuous-integration)

[ubuntu-sdk-build-bot (ubuntu-sdk-build-bot)]

FAILED: Continuous integration, rev:1967
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/746/
Executed test runs:
    FAILURE: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-armhf-stable/1394/console
    FAILURE: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-stable/1401/console
    FAILURE: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-amd64-devel/1185/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci-i386-gles-stable/1151
    None: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6296/console
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6295
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6294
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6288
    SUCCESS: https://jenkins.ubuntu.com/ubuntu-sdk/job/generic-update-mp/6293

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/ubuntu-sdk/job/ubuntu-ui-toolkit-ci/746/rebuild

review: Needs Fixing (continuous-integration)

Unmerged revisions

1967. By Cris Dywan on 2016-05-04

Fail doc generation on missing \inherits tags

=== modified file 'documentation/docs.sh'
--- documentation/docs.sh	2015-05-19 09:16:44 +0000
+++ documentation/docs.sh	2016-05-04 11:46:02 +0000
@@ -33,6 +33,15 @@
 test ! -s $DOC_PATH/qdoc.err || exit 1
 echo docs: Offline done.
 
+# Verify inheritance
+grep -m 1 import $DOC_PATH/offline/qml-ubuntu-*.html | grep -v 'Inherits:' | sed -r "s@([^:]+).+@\1@g" > $DOC_PATH/qdoc.err
+if [ -s $DOC_PATH/qdoc.err ]; then
+    echo 'Missing \inherits tag in the following components:'
+    cat $DOC_PATH/qdoc.err
+    exit 1
+fi
+echo docs: \inherits tags verified.
+
 eval "$QHELPGENERATOR -o '$DOC_PATH/ubuntuuserinterfacetoolkit.qch' '$DOC_PATH/offline/ubuntuuserinterfacetoolkit.qhp' | grep -v ' does not exist! Skipping it'"
 echo docs: qch done: $DOC_PATH