Commit Graph

10 Commits

Author SHA1 Message Date
Scott Rifenbark 4ec8e88a9a documentation: Updated customization layers to point to XSL mirrors
The customization layers were pointing to Sourceforge site for the
XSl files needed to build the manuals.  Throuhgout time, this site
has failed me enough to warrent trying to get these XSL files from
some other source.  Rather than ship the XSL files with the YP release,
we decided to create some mirrors and point the customization files
there.

(From yocto-docs rev: 4fd1703870694dff1f593b421f90aad0803d9e65)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:30 +01:00
Scott Rifenbark be7e182140 documentation: Reverted back to the 1.76.1 XSL stylesheet
Using the 1.76.1 version in all the customization layers so
the manual revision tables will build with boxes.

(From yocto-docs rev: 85a31ef53a59d17bed23ebf57a14db507eb21338)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:56 +00:00
Scott Rifenbark d250d38974 documentation: Changed back to the "current" XSL style sheet.
I need to get back to how it was working and then fix the table
box issue from there.  Using the 1.76.1 stylesheets makes the
build too long for the manuals and sometimes the XSL sheets do
not load.

(From yocto-docs rev: 7bc502fa069fdc4aebf5705513bb82127716859f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Scott Rifenbark 46f120c85c documentation: Updated all XSL style sheet imports to use 1.76.1 version
This fixes the issue where the lines for the manual revision table
are not appearing.  For some reason they do not appear when building
the docs using Ubuntu 14.10 and the "current" XSL transformation
files.  So, I backed up to the 1.76.1 version, which is the nearest
version where the issue does not surface.

(From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:26:59 +00:00
Scott Rifenbark 3e991ee685 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 <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>
2014-10-10 16:44:34 +01:00
Scott Rifenbark 6b5398f82b ref-manual: Added support for variable permalinks in the glossary.
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>
2014-07-03 13:57:09 +01:00
Scott Rifenbark 5aa464ca26 ref-manual-customization.xsl: Changes to custom layer to support permalinks.
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>
2014-06-18 10:30:46 +01:00
Scott Rifenbark 59d810eaca ref-manual: Added new chapter on QA error and warning messages.
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>
2014-05-30 16:32:14 +01:00
Timo Mueller e3980c4938 documentation: Move poky-ref-manual global parameters to customization file
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>
2013-02-14 17:14:58 +00:00
Scott Rifenbark ed0a240e16 documentation: Rename of poky-ref-manual folder to ref-manual.
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>
2013-01-07 14:43:25 +00:00