Skip to contentSkip to conversation

Add eclipse help generation for remaining documents

PATCH Superseded [email protected] 1 participant 26 messages Sep 20, 2012

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover Add eclipse help generation for remaining documents

From: Timo Mueller <[email protected]>

Hi,

I've recently submitted a proof of concept showing how eclipse help files can be generated from the adt-manual using the docbook eclipse3.xsl stylesheet. These patches are currently in the temporary branch 'timo' in the yocto-docs git.

This patch series fixes a small bug and adds eclipse help generation support for the other documentation parts.

1: Small bug fix stopping eclipse target when generation fails 2..6: Add eclipse generation to dev-manual
7..11: Add eclipse generation to bsp-guide
12..16: Add eclipse generation to kernel-manual 17..21: Add eclipse generation to poky-ref-manual 22..25: Add eclipse generation to yocto-project-qs

Best regards,
Timo

Timo Mueller (25):
documentation/Makefile: Stop eclipse target workflow if generation
fails.
documentation: Move dev-manual global parameters to customization
file
documentation/dev-manual/dev-manual-eclipse-customization.xsl: new
file
documentation/Makefile: Support for making Eclipse HTML dev manual documentation/dev-manual/dev-manual.xml: Added Title tag documentation/Makefile: logic to make all for adt manual and cleanup
documentation: Move bsp-guide global parameters to customization file documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new file documentation/Makefile: Support for making Eclipse HTML bsp guide documentation/bsp-guide/bsp-guide.xml: Added Title tag documentation/Makefile: logic to make all for bsp guide and cleanup
documentation: Move kernel-manual global parameters to customization
file
documentation/kernel-manual/kernel-manual-eclipse-customization.xsl:
new file
documentation/Makefile: Support for making Eclipse HTML kernel manual documentation/kernel-manual/kernel-manual.xml: Added Title tag documentation/Makefile: logic to make all for kernel-manual and
cleanup
documentation: Move poky-ref-manual global parameters to
customization file
documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl:
new file
documentation/Makefile: Support for making Eclipse HTML poky ref
manual
documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tag documentation/Makefile: logic to make all for poky-ref-manual and
cleanup
documentation: Move yocto-project-qs global parameters to
customization file
documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl:
new file
documentation/Makefile: Support for making Eclipse HTML yocto project
qs manual
documentation/Makefile: logic to make all for yocto-project-qs and
cleanup

 documentation/Makefile                             |   96 ++++++++++----------
 .../bsp-guide/bsp-guide-customization.xsl          |    4 +
 .../bsp-guide/bsp-guide-eclipse-customization.xsl  |   21 +++++
 documentation/bsp-guide/bsp-guide.xml              |    4 +-
 .../dev-manual/dev-manual-customization.xsl        |    6 +-
 .../dev-manual-eclipse-customization.xsl           |   21 +++++
 documentation/dev-manual/dev-manual.xml            |    4 +-
 .../kernel-manual/kernel-manual-customization.xsl  |    7 +-
 .../kernel-manual-eclipse-customization.xsl        |   21 +++++
 documentation/kernel-manual/kernel-manual.xml      |    4 +-
 .../poky-ref-manual-customization.xsl              |    5 +
 .../poky-ref-manual-eclipse-customization.xsl      |   21 +++++
 documentation/poky-ref-manual/poky-ref-manual.xml  |    4 +-
 .../yocto-project-qs-customization.xsl             |    2 +-
 .../yocto-project-qs-eclipse-customization.xsl     |   20 ++++
 15 files changed, 182 insertions(+), 58 deletions(-)
 create mode 100644 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl
 create mode 100644 documentation/dev-manual/dev-manual-eclipse-customization.xsl
 create mode 100644 documentation/kernel-manual/kernel-manual-eclipse-customization.xsl
 create mode 100644 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl
 create mode 100644 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl
Signature · 1 line
1.7.7.6
#1 lore raw

PATCH 1/25 documentation/Makefile: Stop eclipse target workflow if generation fails.

From: Timo Mueller <[email protected]>

---
 documentation/Makefile |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)
documentation/Makefile +4 -4
index 0537c22..005d670 100644
@@ -295,13 +295,13 @@ ifneq ($(DOC),adt-manual)
 	@echo "       User's Guide"
 	@echo " "
 else
-	cd $(DOC); \
+	cd $(DOC) && \
 		xsltproc $(XSLTOPTS) \
 				--stringparam base.dir '$(BASE_DIR)' \
 				-o eclipse/$(DOC).html \
-				$(DOC)-eclipse-customization.xsl $(DOC).xml; \
-		mv eclipse/toc.xml eclipse/$(DOC)-toc.xml; \
-		cp -rf $(FIGURES) eclipse/$(BASE_DIR)/$(FIGURES); \
+				$(DOC)-eclipse-customization.xsl $(DOC).xml && \
+		mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \
+		cp -rf $(FIGURES) eclipse/$(BASE_DIR)/$(FIGURES) && \
 		cd ..
 endif
 
Signature · 1 line
1.7.7.6
#2 lore raw

PATCH 2/25 documentation: Move dev-manual global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    6 +-----
 .../dev-manual/dev-manual-customization.xsl        |    6 ++++--
 2 files changed, 5 insertions(+), 7 deletions(-)
documentation/Makefile +1 -5
index 005d670..1e8b558 100644
@@ -84,11 +84,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),dev-manual)
-XSLTOPTS = --stringparam html.stylesheet dev-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 #
 # Note that the tarfile might produce the "Cannot stat: No such file or directory" error
documentation/dev-manual/dev-manual-customization.xsl +4 -2
index 8eb6905..8969605 100644
@@ -3,6 +3,8 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
-<!--  <xsl:param name="generate.toc" select="'article nop'"></xsl:param>  -->
-
+  <xsl:param name="html.stylesheet" select="'dev-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>
Signature · 1 line
1.7.7.6
#3 lore raw

PATCH 3/25 documentation/dev-manual/dev-manual-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

This stylesheet uses the eclipse stylesheets of docbook to create eclipse help from this documentation. In addition to simple html files these stylesheets will also create xml files which are needed to integrate the documentation into eclipse (e.g. toc.xml).

---
 .../dev-manual-eclipse-customization.xsl           |   21 ++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
 create mode 100644 documentation/dev-manual/dev-manual-eclipse-customization.xsl
documentation/dev-manual/dev-manual-eclipse-customization.xsl new file +21 -0
new file mode 100644
index 0000000..3463512
@@ -0,0 +1,21 @@
+<?xml version='1.0'?>
+<xsl:stylesheet
+	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+	xmlns="http://www.w3.org/1999/xhtml"
+	xmlns:fo="http://www.w3.org/1999/XSL/Format"
+	version="1.0">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="base.dir" select="'html/dev-manual/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>
Signature · 1 line
1.7.7.6
#4 lore raw

PATCH 4/25 documentation/Makefile: Support for making Eclipse HTML dev manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the dev-manual using the dev-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)
documentation/Makefile +6 -4
index 1e8b558..812a6d7 100644
@@ -284,11 +284,13 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifneq ($(DOC),adt-manual)
+ifeq ($(filter $(DOC), adt-manual dev-manual),)
 	@echo " "
-	@echo "ERROR: You can only create eclipse documentation of the"
-	@echo "       Yocto Project Application Development Toolkit (ADT)"
-	@echo "       User's Guide"
+	@echo "ERROR: You can only create eclipse documentation"
+	@echo "       of the following documentation parts:"
+	@echo " "
+	@echo "       - The Yocto Project Application Developer's Guide (adt-manual)"
+	@echo "       - The Yocto Project Development Manual (dev-manual)"
 	@echo " "
 else
 	cd $(DOC) && \
Signature · 1 line
1.7.7.6
#5 lore raw

PATCH 5/25 documentation/dev-manual/dev-manual.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/dev-manual/dev-manual.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/dev-manual/dev-manual.xml +3 -1
index 0cbd85f..9617fa0 100644
@@ -16,7 +16,9 @@
             </imageobject> 
         </mediaobject>
 
-        <title></title> 
+        <title>
+		  The Yocto Project Development Manual
+		</title>
 
         <authorgroup>
             <author>
Signature · 1 line
1.7.7.6
#6 lore raw

PATCH 6/25 documentation/Makefile: logic to make all for adt manual and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the dev-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |   13 ++++++++-----
 1 files changed, 8 insertions(+), 5 deletions(-)
documentation/Makefile +8 -5
index 812a6d7..45ba6b6 100644
@@ -85,7 +85,7 @@ endif
 
 ifeq ($(DOC),dev-manual)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
+ALLPREQ = html pdf eclipse tarball
 #
 # Note that the tarfile might produce the "Cannot stat: No such file or directory" error
 # message for .PNG files that are not present when building a particular branch.  The 
@@ -101,7 +101,8 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
            figures/kernel-overview-1.png figures/kernel-overview-2.png \
            figures/kernel-overview-3-edison.png \
            figures/source-repos.png figures/yp-download.png \
-           figures/wip.png
+           figures/wip.png \
+           eclipse
 	else ifeq ($(BRANCH),denzil)
 TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
            figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
@@ -110,7 +111,8 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
            figures/kernel-overview-1.png figures/kernel-overview-2.png \
            figures/kernel-overview-3-denzil.png \
            figures/source-repos.png figures/yp-download.png \
-           figures/wip.png
+           figures/wip.png \
+           eclipse
         else
 TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
            figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
@@ -119,10 +121,11 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
            figures/kernel-overview-1.png figures/kernel-overview-2.png \
            figures/kernel-overview-3-denzil.png \
            figures/source-repos.png figures/yp-download.png \
-           figures/wip.png
+           figures/wip.png \
+           eclipse
 	endif
 
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 
Signature · 1 line
1.7.7.6
#7 lore raw

PATCH 7/25 documentation: Move bsp-guide global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    6 +-----
 .../bsp-guide/bsp-guide-customization.xsl          |    4 ++++
 2 files changed, 5 insertions(+), 5 deletions(-)
documentation/Makefile +1 -5
index 45ba6b6..e601fef 100644
@@ -70,11 +70,7 @@
 #
 
 ifeq ($(DOC),bsp-guide)
-XSLTOPTS = --stringparam html.stylesheet bsp-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
 MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
documentation/bsp-guide/bsp-guide-customization.xsl +4 -0
index 362ebed..5560289 100644
@@ -3,4 +3,8 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
+  <xsl:param name="html.stylesheet" select="'bsp-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>
Signature · 1 line
1.7.7.6
#8 lore raw

PATCH 8/25 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

This stylesheet uses the eclipse stylesheets of docbook to create eclipse help from this documentation. In addition to simple html files these stylesheets will also create xml files which are needed to integrate the documentation into eclipse (e.g. toc.xml).

---
 .../bsp-guide/bsp-guide-eclipse-customization.xsl  |   21 ++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
 create mode 100644 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl
documentation/bsp-guide/bsp-guide-eclipse-customization.xsl new file +21 -0
new file mode 100644
index 0000000..d85d901
@@ -0,0 +1,21 @@
+<?xml version='1.0'?>
+<xsl:stylesheet
+	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+	xmlns="http://www.w3.org/1999/xhtml"
+	xmlns:fo="http://www.w3.org/1999/XSL/Format"
+	version="1.0">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="base.dir" select="'html/bsp-guide/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="1" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>
Signature · 1 line
1.7.7.6
#9 lore raw

PATCH 9/25 documentation/Makefile: Support for making Eclipse HTML bsp guide

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the bsp-guide using the bsp-guide-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/Makefile +3 -1
index e601fef..815ab53 100644
@@ -283,12 +283,14 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual dev-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"
 	@echo " "
 	@echo "       - The Yocto Project Application Developer's Guide (adt-manual)"
+	@echo "       - The Yocto Project Board Support Package"
+	@echo "                           Developer's Guide (bsp-guide)"
 	@echo "       - The Yocto Project Development Manual (dev-manual)"
 	@echo " "
 else
Signature · 1 line
1.7.7.6
#10 lore raw

PATCH 10/25 documentation/bsp-guide/bsp-guide.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/bsp-guide/bsp-guide.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp-guide.xml +3 -1
index 3b7ab6a..c3629bd 100644
@@ -16,7 +16,9 @@
             </imageobject>    
         </mediaobject>
 
-        <title></title> 
+        <title>
+		  The Yocto Project Board Support Package Developer's Guide
+		</title>
 
         <authorgroup>
             <author>
Signature · 1 line
1.7.7.6
#11 lore raw

PATCH 11/25 documentation/Makefile: logic to make all for bsp guide and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the bsp-guide. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)
documentation/Makefile +4 -3
index 815ab53..02206b5 100644
@@ -71,9 +71,10 @@
 
 ifeq ($(DOC),bsp-guide)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
-TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+ALLPREQ = html pdf eclipse tarball
+TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png \
+           eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 
Signature · 1 line
1.7.7.6
#12 lore raw

PATCH 12/25 documentation: Move kernel-manual global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    7 +------
 .../kernel-manual/kernel-manual-customization.xsl  |    7 +++++--
 2 files changed, 6 insertions(+), 8 deletions(-)
documentation/Makefile +1 -6
index 02206b5..9b816a1 100644
@@ -219,12 +219,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),kernel-manual)
-XSLTOPTS = --stringparam html.stylesheet kernel-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  appendix.autolabel A \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 TARFILES = kernel-manual.html kernel-manual.pdf kernel-style.css figures/kernel-title.png figures/kernel-architecture-overview.png
 MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
documentation/kernel-manual/kernel-manual-customization.xsl +5 -2
index 8eb6905..6f46df2 100644
@@ -3,6 +3,9 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
-<!--  <xsl:param name="generate.toc" select="'article nop'"></xsl:param>  -->
-
+  <xsl:param name="html.stylesheet" select="'kernel-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>
Signature · 1 line
1.7.7.6
#13 lore raw

PATCH 13/25 documentation/kernel-manual/kernel-manual-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

This stylesheet uses the eclipse stylesheets of docbook to create eclipse help from this documentation. In addition to simple html files these stylesheets will also create xml files which are needed to integrate the documentation into eclipse (e.g. toc.xml).

---
 .../kernel-manual-eclipse-customization.xsl        |   21 ++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
 create mode 100644 documentation/kernel-manual/kernel-manual-eclipse-customization.xsl
documentation/kernel-manual/kernel-manual-eclipse-customization.xsl new file +21 -0
new file mode 100644
index 0000000..2980869
@@ -0,0 +1,21 @@
+<?xml version='1.0'?>
+<xsl:stylesheet
+	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+	xmlns="http://www.w3.org/1999/xhtml"
+	xmlns:fo="http://www.w3.org/1999/XSL/Format"
+	version="1.0">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="base.dir" select="'html/kernel-manual/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>
Signature · 1 line
1.7.7.6
#14 lore raw

PATCH 14/25 documentation/Makefile: Support for making Eclipse HTML kernel manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the kernel-manual using the kernel-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/Makefile +3 -1
index 9b816a1..f64e21c 100644
@@ -279,7 +279,7 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"
@@ -288,6 +288,8 @@ ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual),)
 	@echo "       - The Yocto Project Board Support Package"
 	@echo "                           Developer's Guide (bsp-guide)"
 	@echo "       - The Yocto Project Development Manual (dev-manual)"
+	@echo "       - The Yocto Project Kernel Architecture and"
+	@echo "                           Use Manual (kernel-manual)"
 	@echo " "
 else
 	cd $(DOC) && \
Signature · 1 line
1.7.7.6
#15 lore raw

PATCH 15/25 documentation/kernel-manual/kernel-manual.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/kernel-manual/kernel-manual.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/kernel-manual/kernel-manual.xml +3 -1
index 174663a..0d683ef 100644
@@ -16,7 +16,9 @@
             </imageobject>    
         </mediaobject>
 
-        <title></title> 
+        <title>
+		  The Yocto Project Kernel Architecture and Use Manual
+		</title>
 
         <authorgroup>
             <author>
Signature · 1 line
1.7.7.6
#16 lore raw

PATCH 16/25 documentation/Makefile: logic to make all for kernel-manual and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the kernel-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
documentation/Makefile +5 -3
index f64e21c..23b4d9f 100644
@@ -220,9 +220,11 @@ endif
 
 ifeq ($(DOC),kernel-manual)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
-TARFILES = kernel-manual.html kernel-manual.pdf kernel-style.css figures/kernel-title.png figures/kernel-architecture-overview.png
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+ALLPREQ = html pdf eclipse tarball
+TARFILES = kernel-manual.html kernel-manual.pdf kernel-style.css \
+           figures/kernel-title.png figures/kernel-architecture-overview.png \
+           eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 endif
Signature · 1 line
1.7.7.6
#17 lore raw

PATCH 17/25 documentation: Move poky-ref-manual global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    7 +------
 .../poky-ref-manual-customization.xsl              |    5 +++++
 2 files changed, 6 insertions(+), 6 deletions(-)
documentation/Makefile +1 -6
index 23b4d9f..17f7cf5 100644
@@ -194,12 +194,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),poky-ref-manual)
-XSLTOPTS = --stringparam html.stylesheet ref-style.css \
-           --stringparam  chapter.autolabel 1 \
-           --stringparam  appendix.autolabel A \
-           --stringparam  section.autolabel 1 \
-           --stringparam  section.label.includes.component.label 1 \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html pdf tarball
 TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png
 MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
documentation/poky-ref-manual/poky-ref-manual-customization.xsl +5 -0
index 362ebed..3ad3a31 100644
@@ -3,4 +3,9 @@
   
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
+  <xsl:param name="html.stylesheet" select="'ref-style.css'" />
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
 </xsl:stylesheet>
Signature · 1 line
1.7.7.6
#18 lore raw

PATCH 18/25 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

This stylesheet uses the eclipse stylesheets of docbook to create eclipse help from this documentation. In addition to simple html files these stylesheets will also create xml files which are needed to integrate the documentation into eclipse (e.g. toc.xml).

---
 .../poky-ref-manual-eclipse-customization.xsl      |   21 ++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
 create mode 100644 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl
documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl new file +21 -0
new file mode 100644
index 0000000..40181e2
@@ -0,0 +1,21 @@
+<?xml version='1.0'?>
+<xsl:stylesheet
+	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+	xmlns="http://www.w3.org/1999/xhtml"
+	xmlns:fo="http://www.w3.org/1999/XSL/Format"
+	version="1.0">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="base.dir" select="'html/poky-ref-manual/'"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="chapter.autolabel" select="1" />
+  <xsl:param name="appendix.autolabel" select="A" />
+  <xsl:param name="section.autolabel" select="1" />
+  <xsl:param name="section.label.includes.component.label" select="1" />
+</xsl:stylesheet>
Signature · 1 line
1.7.7.6
#19 lore raw

PATCH 19/25 documentation/Makefile: Support for making Eclipse HTML poky ref manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the poky-ref-manual using the poky-ref-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
documentation/Makefile +2 -1
index 17f7cf5..ba26214 100644
@@ -276,7 +276,7 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"
@@ -287,6 +287,7 @@ ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual),)
 	@echo "       - The Yocto Project Development Manual (dev-manual)"
 	@echo "       - The Yocto Project Kernel Architecture and"
 	@echo "                           Use Manual (kernel-manual)"
+	@echo "		  - The Yocto Project Reference Manual (poky-ref-manual)"
 	@echo " "
 else
 	cd $(DOC) && \
Signature · 1 line
1.7.7.6
#20 lore raw

PATCH 20/25 documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tag

From: Timo Mueller <[email protected]>

The title of the document used to create metadata for output formats such as eclipse help.

---
 documentation/poky-ref-manual/poky-ref-manual.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/poky-ref-manual/poky-ref-manual.xml +3 -1
index e405375..61497d5 100644
@@ -16,7 +16,9 @@
             </imageobject>    
         </mediaobject>
 
-        <title></title>
+        <title>
+		  The Yocto Project Reference Manual
+		</title>
 
         <authorgroup>
             <author>
Signature · 1 line
1.7.7.6
#21 lore raw

PATCH 21/25 documentation/Makefile: logic to make all for poky-ref-manual and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the poky-ref-manual. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
documentation/Makefile +3 -3
index ba26214..33ebd3c 100644
@@ -195,9 +195,9 @@ endif
 
 ifeq ($(DOC),poky-ref-manual)
 XSLTOPTS = --xinclude
-ALLPREQ = html pdf tarball
-TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png
-MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
+ALLPREQ = html pdf eclipse tarball
+TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 endif
Signature · 1 line
1.7.7.6
#22 lore raw

PATCH 22/25 documentation: Move yocto-project-qs global parameters to customization file

From: Timo Mueller <[email protected]>

Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile.

---
 documentation/Makefile                             |    3 +--
 .../yocto-project-qs-customization.xsl             |    2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)
documentation/Makefile +1 -2
index 33ebd3c..2887a95 100644
@@ -129,8 +129,7 @@ STYLESHEET = $(DOC)/*.css
 endif
 
 ifeq ($(DOC),yocto-project-qs)
-XSLTOPTS = --stringparam html.stylesheet qs-style.css \
-           --xinclude
+XSLTOPTS = --xinclude
 ALLPREQ = html tarball
 TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png
 MANUALS = $(DOC)/$(DOC).html
documentation/yocto-project-qs/yocto-project-qs-customization.xsl +1 -1
index 8e6ea34..904289a 100644
@@ -4,5 +4,5 @@
   <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
 
   <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
-
+  <xsl:param name="html.stylesheet" select="'qs-style.css'" />
 </xsl:stylesheet>
Signature · 1 line
1.7.7.6
#23 lore raw

PATCH 23/25 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl: new file

From: Timo Mueller <[email protected]>

This stylesheet uses the eclipse stylesheets of docbook to create eclipse help from this documentation. In addition to simple html files these stylesheets will also create xml files which are needed to integrate the documentation into eclipse (e.g. toc.xml).

---
 .../yocto-project-qs-eclipse-customization.xsl     |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)
 create mode 100644 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl
documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl new file +20 -0
new file mode 100644
index 0000000..cff787f
@@ -0,0 +1,20 @@
+<?xml version='1.0'?>
+<xsl:stylesheet
+	xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+	xmlns="http://www.w3.org/1999/xhtml"
+	xmlns:fo="http://www.w3.org/1999/XSL/Format"
+	version="1.0">
+
+  <xsl:import
+	  href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
+
+  <xsl:param name="base.dir" select="'html/yocto-project-qs/'"/>
+  <xsl:param name="chunk.section.depth" select="0"/>
+  <xsl:param name="html.stylesheet" select="'../book.css'"/>
+  <xsl:param name="eclipse.manifest" select="0"/>
+  <xsl:param name="create.plugin.xml" select="0"/>
+  <xsl:param name="suppress.navigation" select="1"/>
+  <xsl:param name="generate.index" select="0"/>
+  <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
+  <xsl:param name="html.stylesheet" select="'style.css'" />
+</xsl:stylesheet>
Signature · 1 line
1.7.7.6
#24 lore raw

PATCH 24/25 documentation/Makefile: Support for making Eclipse HTML yocto project qs manual

From: Timo Mueller <[email protected]>

This target will generate eclipse help for the yocto-project-qs using the yocto-project-qs-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used for integrating the documentation into eclipse.

---
 documentation/Makefile |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
documentation/Makefile +2 -1
index 2887a95..1a29af5 100644
@@ -275,7 +275,7 @@ endif
 eclipse: BASE_DIR = html/$(DOC)/
 
 eclipse:
-ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual),)
+ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-manual yocto-project-qs),)
 	@echo " "
 	@echo "ERROR: You can only create eclipse documentation"
 	@echo "       of the following documentation parts:"
@@ -287,6 +287,7 @@ ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-manual poky-ref-ma
 	@echo "       - The Yocto Project Kernel Architecture and"
 	@echo "                           Use Manual (kernel-manual)"
 	@echo "		  - The Yocto Project Reference Manual (poky-ref-manual)"
+	@echo "       - The Yocto Project Quick Start (yocto-project-qs)"
 	@echo " "
 else
 	cd $(DOC) && \
Signature · 1 line
1.7.7.6
#25 lore raw

PATCH 25/25 documentation/Makefile: logic to make all for yocto-project-qs and cleanup

From: Timo Mueller <[email protected]>

Eclipse help documents are now created when calling the 'make all' target on the yocto-project-qs. Resulting files are archived into the tarball as well. When calling 'make clean' artefacts of the eclipse documentation build are deleted.

---
 documentation/Makefile |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)
documentation/Makefile +6 -3
index 1a29af5..4965c30 100644
@@ -130,9 +130,12 @@ endif
 
 ifeq ($(DOC),yocto-project-qs)
 XSLTOPTS = --xinclude
-ALLPREQ = html tarball
-TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png figures/building-an-image.png figures/using-a-pre-built-image.png figures/yocto-project-transp.png
-MANUALS = $(DOC)/$(DOC).html
+ALLPREQ = html eclipse tarball
+TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \
+           figures/building-an-image.png figures/using-a-pre-built-image.png \
+           figures/yocto-project-transp.png \
+           eclipse
+MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
 FIGURES = figures
 STYLESHEET = $(DOC)/*.css
 endif
Signature · 1 line
1.7.7.6