From 3e991ee6851d9396e99aab37b8706426ff5185f1 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 6 Oct 2014 12:46:00 -0700 Subject: [PATCH] ref-manual, template: Permalinks for QA errors and warnings Updated the ref-qa-checks.xml chapter so that each QA warning or error message would generate a permalink that is suitable for searching from the poky codebase. To implement this, I had to embed an id marker in the tag that precedes each tag pair. The 'xxx' string of the id is the leaf portion of the permalink. This creates the following tag construct: some-warning-or-error-message The permalink is generated with the help of the new qa-code-permalinks.xsl file, which triggers on the construct. This new file resides in documentation/template. Right now, this construct is unique to the ref-manual's chapter on the QA error and warnings chapter only. However, if for some reason that construct is used in any other part of the ref-manual, a generically numbered permalink would also be generated. The ref-manual-customization.xsl file was also altered to include the new documentation/template/qa-code-permalinks.xsl file. Reported-by: Paul Eggleton (From yocto-docs rev: aec27a9f8337575d31bfe0066563da99259046e0) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../ref-manual/ref-manual-customization.xsl | 1 + documentation/ref-manual/ref-qa-checks.xml | 83 ++++++++++--------- documentation/template/qa-code-permalinks.xsl | 23 +++++ 3 files changed, 67 insertions(+), 40 deletions(-) create mode 100644 documentation/template/qa-code-permalinks.xsl diff --git a/documentation/ref-manual/ref-manual-customization.xsl b/documentation/ref-manual/ref-manual-customization.xsl index 05c9b979b1..b58b1dcaf9 100644 --- a/documentation/ref-manual/ref-manual-customization.xsl +++ b/documentation/ref-manual/ref-manual-customization.xsl @@ -9,6 +9,7 @@ + diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml index 15c1bbe4f5..3f4e7d8fa1 100644 --- a/documentation/ref-manual/ref-qa-checks.xml +++ b/documentation/ref-manual/ref-qa-checks.xml @@ -59,10 +59,21 @@
Errors and Warnings + + - + <packagename>: <path> is using libexec please relocate to <libexecdir> [libexec] @@ -87,7 +98,7 @@ - + package <packagename> contains bad RPATH <rpath> in file <file> [rpaths] @@ -119,7 +130,7 @@ - + <packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths] @@ -147,7 +158,7 @@ - + non -dev/-dbg/-nativesdk package contains symlink .so: <packagename> path '<path>' [dev-so] @@ -178,7 +189,7 @@ - + non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev] @@ -205,7 +216,7 @@ - + <packagename>: found library in wrong location [libdir] @@ -236,7 +247,7 @@ - + non debug package contains .debug directory: <packagename> path <path> [debug-files] @@ -269,7 +280,7 @@ - + Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch] @@ -308,7 +319,7 @@ - + Bit size did not match (<machine_bits> to <file_bits>) <recipe> on <file> [arch] @@ -347,7 +358,7 @@ - + Endianness did not match (<machine_endianness> to <file_endianness>) on <file> [arch] @@ -386,7 +397,7 @@ - + ELF binary '<file>' has relocations in .text [textrel] @@ -397,13 +408,6 @@ .text sections. This situation can result in a performance impact at runtime. - - A bug currently exists that causes this - warning to appear erroneously. - See - - for more information. - @@ -416,7 +420,7 @@ - + No GNU_HASH in the elf binary: '<file>' [ldflags] @@ -448,7 +452,7 @@ - + Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi] @@ -478,7 +482,7 @@ - + The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir] @@ -506,7 +510,7 @@ - + Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot] @@ -533,7 +537,7 @@ - + <file> failed sanity test (workdir) in path <path> [la] @@ -559,7 +563,7 @@ - + <file> failed sanity test (tmpdir) in path <path> [pkgconfig] @@ -584,7 +588,7 @@ - + <packagename> rdepends on <debug_packagename> [debug-deps] @@ -632,7 +636,7 @@ - + <packagename> rdepends on <dev_packagename> [dev-deps] @@ -680,7 +684,7 @@ - + <var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp] @@ -711,7 +715,7 @@ - + <recipename>: The compile log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [compile-host-path] @@ -736,7 +740,7 @@ - + <recipename>: The install log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [install-host-path] @@ -761,7 +765,7 @@ - + This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was '<path>' @@ -786,7 +790,7 @@ - + <packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname] @@ -818,7 +822,7 @@ - + <recipe>: configure was passed unrecognized options: <options> [unknown-configure-option] @@ -854,7 +858,7 @@ - + Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides] @@ -894,7 +898,7 @@ - + <recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck] @@ -932,7 +936,7 @@ - + File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped] @@ -977,7 +981,7 @@ - + <packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list] @@ -1002,7 +1006,7 @@ - + FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid] @@ -1025,7 +1029,7 @@ - + <recipename>: Files/directories were installed but not shipped [installed-vs-shipped] @@ -1065,7 +1069,7 @@ - + <oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later @@ -1151,7 +1155,6 @@ enabled by default:
- + + + + + + + + + + +