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 <para> tag that precedes each
<code></code> tag pair. The 'xxx' string of the id is the leaf
portion of the permalink.
This creates the following tag construct:
<para id='xxx'>
<code>
some-warning-or-error-message
</code>
</para>
The permalink is generated with the help of the new
qa-code-permalinks.xsl file, which triggers on the
<para><code></code></para> 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 <paul.eggleton@linux.intel.com>
(From yocto-docs rev: aec27a9f8337575d31bfe0066563da99259046e0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5772]
Updated the customization layer to include the file that generates
permalinks for the variable definitions.
(From yocto-docs rev: adfb6f06fcba2045e56353bcff0df1df9106544c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5772]
Added some code to suck in the XSL templates that support
permalinks.
(From yocto-docs rev: 713a17465df48de2ece3845bbd7a8bf972e353b0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This new chapter is a reference on the default configuration
QA check messages you can get from errors and warnings.
(From yocto-docs rev: 04d766b4e1235ae46df38c4b296cb2729b6a439f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changing the folder that holds the YP Reference Manual to be
"ref-manual". This will help with confustion over the manual's
intended purpose.
(From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
