[yocto] [PATCHv2 01/35] documentation/template/titlepage.templates.xml: Remove title info
From: Timo Mueller The title of a pdf document is part of the image used on the title page. Thus the title defined (e.g. bookinfo.title) in a document should never be used when creating title pages for pdf documents. As other output formats may use the title information to create metadata the title has been removed from the template. --- documentation/template/titlepage.templates.xml | 13 - 1 files changed, 0 insertions(+), 13 deletions(-) diff --git a/documentation/template/titlepage.templates.xml b/documentation/template/titlepage.templates.xml index ff640fa..f53f147 100644 --- a/documentation/template/titlepage.templates.xml +++ b/documentation/template/titlepage.templates.xml @@ -140,14 +140,6 @@ - - -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 02/35] documentation: Move adt-manual global parameters to customization file
From: Timo Mueller Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Furthermore supporting new output formats can now be achieved by creating a new customization file containing its corresponding parameters. Parameters that are used across different stylesheets with different values will then be separated through different customization files. Global parameters can still be set through the XSLTOPTS variable since this precedes the parameters in the customization file. --- documentation/Makefile |7 +-- .../adt-manual/adt-manual-customization.xsl|7 +-- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 6cac5ca..9a15651 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -208,12 +208,7 @@ endif ifeq ($(DOC),adt-manual) -XSLTOPTS = --stringparam html.stylesheet adt-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 = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf diff --git a/documentation/adt-manual/adt-manual-customization.xsl b/documentation/adt-manual/adt-manual-customization.xsl index 8eb6905..373bdb7 100644 --- a/documentation/adt-manual/adt-manual-customization.xsl +++ b/documentation/adt-manual/adt-manual-customization.xsl @@ -3,6 +3,9 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> - - + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 03/35] documentation/adt-manual/adt-manual-eclipse-customization.xsl: new file
From: Timo Mueller 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). Additional parameters are required so resolve links between different documentation parts inside eclipse. --- .../adt-manual-eclipse-customization.xsl | 26 1 files changed, 26 insertions(+), 0 deletions(-) create mode 100644 documentation/adt-manual/adt-manual-eclipse-customization.xsl diff --git a/documentation/adt-manual/adt-manual-eclipse-customization.xsl b/documentation/adt-manual/adt-manual-eclipse-customization.xsl new file mode 100644 index 000..ff1464e --- /dev/null +++ b/documentation/adt-manual/adt-manual-eclipse-customization.xsl @@ -0,0 +1,26 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 00/35][yocto-docs] Add eclipse help generation to build system
From: Timo Mueller Hi, this patch series was put on hold until the successful release of yocto 1.3. This is a rebase of the original patch series that now applies to the current master of the project. Cheers, Timo The original cover letter of the patch: Hi, this is a rework of the patches I've been submitting to include the generation of eclipse help files into the documentation build system. >From original rfc ([yocto-docs] Add eclipse help generation to build system): I've added the target 'eclipse' to the documentation's build system to automate the process of eclipse help generation. This can help to facilitate the process of keeping the integrated documentation in sync with the yocto documentation. This patch set incorporates all changes I've been making so far: 1: Remove the use if title in pdf documents 2..6: Add eclipse generation to adt-manual 7..11: Add eclipse generation to dev-manual 12..16: Add eclipse generation to bsp-guide 17..21: Add eclipse generation to kernel-manual 22..26: Add eclipse generation to poky-ref-manual 27..32: Add eclipse generation to yocto-project-qs 33..34: Handle links between documents 35: Makefile documentation update Best regards, Timo Timo Mueller (35): documentation/template/titlepage.templates.xml: Remove title info documentation: Move adt-manual global parameters to customization file documentation/adt-manual/adt-manual-eclipse-customization.xsl: new file documentation/Makefile: Support for making Eclipse HTML adt manual documentation/adt-manual/adt-manual.xml: Added Title tag documentation/Makefile: logic to make all for adt manual and cleanup 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 dev 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: Added custom title page documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl: new file documentation/Makefile: Support for making Eclipse HTML yocto project qs manual documentation/yocto-project-qs/yocto-project-qs.xml: Convert fake-title section into articleinfo documentation/Makefile: logic to make all for yocto-project-qs and cleanup documentation/tools/eclipse-help.sed: Processes external links for eclipse html files documentation/Makefile: Added conversion of links to other documentation parts. documentation/Makefile: Clean up eclipse target and update help. documentation/Makefile | 119 +- .../adt-manual/adt-manual-customization.xsl|7 +- .../adt-manual-eclipse-customization.xsl | 26 + documentation/adt-manual/adt-manual.xml|4 +- .../bsp-guide/bsp-guide-customization.xsl |4 + .../bsp-guide/bsp-guide-eclipse-customization.xsl | 26 + documentation/bsp-guide/bsp-guide.xml |4 +- .../dev-manual/dev-manual-customization.xsl|6 +- .../dev-manual-eclipse-customization.xsl | 26 + documentation/dev-manual/dev-manual.xml|4 +- .../kernel-manual/kernel-manual-customization.xsl |7 +- .../kernel-manual-eclipse-customization.xsl| 26 + documentation/kernel-manual/kernel-manual.xml |4 +- .../poky-ref-manual-customization.xsl |5 + .../poky-ref-manual-eclipse-customization.xsl | 26 + documentation/poky-ref-manual/poky-ref-manual.xml |4 +- documentation/template/titlepage.templates.xml | 13 - documentation/tools/eclipse-help.sed | 18 + ..
[yocto] [PATCHv2 07/35] documentation: Move dev-manual global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 5af7766..7bcd255 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 diff --git a/documentation/dev-manual/dev-manual-customization.xsl b/documentation/dev-manual/dev-manual-customization.xsl index 8eb6905..8969605 100644 --- a/documentation/dev-manual/dev-manual-customization.xsl +++ b/documentation/dev-manual/dev-manual-customization.xsl @@ -3,6 +3,8 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> - - + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 05/35] documentation/adt-manual/adt-manual.xml: Added Title tag
From: Timo Mueller The title of the document used to create metadata for output formats such as eclipse help. --- documentation/adt-manual/adt-manual.xml |4 +++- 1 files changed, 3 insertions(+), 1 deletions(-) diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml index 25bc27e..3b99547 100644 --- a/documentation/adt-manual/adt-manual.xml +++ b/documentation/adt-manual/adt-manual.xml @@ -16,7 +16,9 @@ - + +The Yocto Project Application Developer's Guide + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 08/35] documentation/dev-manual/dev-manual-eclipse-customization.xsl: new file
From: Timo Mueller 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 | 26 1 files changed, 26 insertions(+), 0 deletions(-) create mode 100644 documentation/dev-manual/dev-manual-eclipse-customization.xsl diff --git a/documentation/dev-manual/dev-manual-eclipse-customization.xsl b/documentation/dev-manual/dev-manual-eclipse-customization.xsl new file mode 100644 index 000..ff1de89 --- /dev/null +++ b/documentation/dev-manual/dev-manual-eclipse-customization.xsl @@ -0,0 +1,26 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 06/35] documentation/Makefile: logic to make all for adt manual and cleanup
From: Timo Mueller Eclipse help documents are now created when calling the 'make all' target on the adt-manual. 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, 5 insertions(+), 4 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index b071efb..5af7766 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -209,9 +209,10 @@ endif ifeq ($(DOC),adt-manual) XSLTOPTS = --xinclude -ALLPREQ = html pdf tarball -TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png -MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf +ALLPREQ = html pdf eclipse tarball +TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png \ + eclipse +MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse FIGURES = figures STYLESHEET = $(DOC)/*.css endif @@ -327,4 +328,4 @@ publish: fi clean: - rm -f $(MANUALS) + rm -rf $(MANUALS) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 09/35] documentation/Makefile: Support for making Eclipse HTML dev manual
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 7bcd255..e57f5c3 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -279,11 +279,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 @echo " " -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 11/35] documentation/Makefile: logic to make all for dev manual and cleanup
From: Timo Mueller 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 |7 --- 1 files changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index e57f5c3..c535517 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 @@ -116,10 +116,11 @@ TARFILES = dev-style.css dev-manual.html dev-manual.pdf \ figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \ figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \ figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \ - figures/source-repos.png figures/yp-download.png + figures/source-repos.png figures/yp-download.png \ + eclipse endif -MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf +MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse FIGURES = figures STYLESHEET = $(DOC)/*.css -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 12/35] documentation: Move bsp-guide global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index c535517..148bb51 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 diff --git a/documentation/bsp-guide/bsp-guide-customization.xsl b/documentation/bsp-guide/bsp-guide-customization.xsl index 362ebed..5560289 100644 --- a/documentation/bsp-guide/bsp-guide-customization.xsl +++ b/documentation/bsp-guide/bsp-guide-customization.xsl @@ -3,4 +3,8 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 13/35] documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new file
From: Timo Mueller 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 | 26 1 files changed, 26 insertions(+), 0 deletions(-) create mode 100644 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl diff --git a/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl new file mode 100644 index 000..b9aceb2 --- /dev/null +++ b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl @@ -0,0 +1,26 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 15/35] documentation/bsp-guide/bsp-guide.xml: Added Title tag
From: Timo Mueller 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(-) diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 5f7551e..ffac7b3 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -16,7 +16,9 @@ - + +The Yocto Project Board Support Package Developer's Guide + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 16/35] documentation/Makefile: logic to make all for bsp guide and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index ea4a6e8..7efead1 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 21/35] documentation/Makefile: logic to make all for kernel-manual and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 3366cad..5596720 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -213,9 +213,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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 10/35] documentation/dev-manual/dev-manual.xml: Added Title tag
From: Timo Mueller 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(-) diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml index 19503a9..0968691 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml @@ -16,7 +16,9 @@ - + +The Yocto Project Development Manual + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 18/35] documentation/kernel-manual/kernel-manual-eclipse-customization.xsl: new file
From: Timo Mueller 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| 26 1 files changed, 26 insertions(+), 0 deletions(-) create mode 100644 documentation/kernel-manual/kernel-manual-eclipse-customization.xsl diff --git a/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl b/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl new file mode 100644 index 000..70a1e19 --- /dev/null +++ b/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl @@ -0,0 +1,26 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 20/35] documentation/kernel-manual/kernel-manual.xml: Added Title tag
From: Timo Mueller 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(-) diff --git a/documentation/kernel-manual/kernel-manual.xml b/documentation/kernel-manual/kernel-manual.xml index 99d7184..f39f4f8 100644 --- a/documentation/kernel-manual/kernel-manual.xml +++ b/documentation/kernel-manual/kernel-manual.xml @@ -16,7 +16,9 @@ - + +The Yocto Project Kernel Architecture and Use Manual + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 23/35] documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl: new file
From: Timo Mueller 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 | 26 1 files changed, 26 insertions(+), 0 deletions(-) create mode 100644 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl diff --git a/documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl b/documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl new file mode 100644 index 000..4e31193 --- /dev/null +++ b/documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl @@ -0,0 +1,26 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 25/35] documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tag
From: Timo Mueller 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(-) diff --git a/documentation/poky-ref-manual/poky-ref-manual.xml b/documentation/poky-ref-manual/poky-ref-manual.xml index 51f5e2d..0479502 100644 --- a/documentation/poky-ref-manual/poky-ref-manual.xml +++ b/documentation/poky-ref-manual/poky-ref-manual.xml @@ -16,7 +16,9 @@ - + +The Yocto Project Reference Manual + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 17/35] documentation: Move kernel-manual global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 7efead1..d050ddc 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -212,12 +212,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 diff --git a/documentation/kernel-manual/kernel-manual-customization.xsl b/documentation/kernel-manual/kernel-manual-customization.xsl index 8eb6905..6f46df2 100644 --- a/documentation/kernel-manual/kernel-manual-customization.xsl +++ b/documentation/kernel-manual/kernel-manual-customization.xsl @@ -3,6 +3,9 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> - - + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 22/35] documentation: Move poky-ref-manual global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 5596720..1645c96 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -186,12 +186,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 \ figures/buildhistory.png figures/buildhistory-web.png diff --git a/documentation/poky-ref-manual/poky-ref-manual-customization.xsl b/documentation/poky-ref-manual/poky-ref-manual-customization.xsl index 362ebed..3ad3a31 100644 --- a/documentation/poky-ref-manual/poky-ref-manual-customization.xsl +++ b/documentation/poky-ref-manual/poky-ref-manual-customization.xsl @@ -3,4 +3,9 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 27/35] documentation: Move yocto-project-qs global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 6939a6c..a24be18 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -124,8 +124,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 diff --git a/documentation/yocto-project-qs/yocto-project-qs-customization.xsl b/documentation/yocto-project-qs/yocto-project-qs-customization.xsl index 8e6ea34..904289a 100644 --- a/documentation/yocto-project-qs/yocto-project-qs-customization.xsl +++ b/documentation/yocto-project-qs/yocto-project-qs-customization.xsl @@ -4,5 +4,5 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> - + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 30/35] documentation/Makefile: Support for making Eclipse HTML yocto project qs manual
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index a24be18..b9b46d2 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -268,7 +268,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:" @@ -280,6 +280,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 @echo " " -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 32/35] documentation/Makefile: logic to make all for yocto-project-qs and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index b9b46d2..7e30b31 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -125,9 +125,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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 24/35] documentation/Makefile: Support for making Eclipse HTML poky ref manual
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 1645c96..b85b14c 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -269,7 +269,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:" @@ -280,6 +280,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 @echo " " -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 26/35] documentation/Makefile: logic to make all for poky-ref-manual and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index b85b14c..6939a6c 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -187,10 +187,10 @@ endif ifeq ($(DOC),poky-ref-manual) XSLTOPTS = --xinclude -ALLPREQ = html pdf tarball +ALLPREQ = html pdf eclipse tarball TARFILES = poky-ref-manual.html ref-style.css figures/poky-title.png \ - figures/buildhistory.png figures/buildhistory-web.png -MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf + figures/buildhistory.png figures/buildhistory-web.png eclipse +MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse FIGURES = figures STYLESHEET = $(DOC)/*.css endif -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 04/35] documentation/Makefile: Support for making Eclipse HTML adt manual
From: Timo Mueller This target will generate eclipse help for the adt-manual using the adt-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 | 23 +++ 1 files changed, 23 insertions(+), 0 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 9a15651..b071efb 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -279,6 +279,29 @@ else endif +eclipse: BASE_DIR = html/$(DOC)/ + +eclipse: +ifneq ($(DOC),adt-manual) + @echo " " + @echo "ERROR: You can only create eclipse documentation of the" + @echo " Yocto Project Application Development Toolkit (ADT)" + @echo " User's Guide" + @echo " " +else + @echo " " + @echo " Building eclipse help of "$(DOC) + @echo " " + 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) && \ + cd .. +endif + tarball: html @echo " " @echo " Creating Tarball of document files" -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 34/35] documentation/Makefile: Added conversion of links to other documentation parts.
From: Timo Mueller The script tools/eclipse-help.sed is used to convert links that point to other documentation parts. This avoids having to leave the eclipse help center when clicking these links. --- documentation/Makefile | 18 -- 1 files changed, 16 insertions(+), 2 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 7e30b31..785c065 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -270,7 +270,11 @@ endif eclipse: BASE_DIR = html/$(DOC)/ -eclipse: +eclipse: eclipse-generate eclipse-resolve-links + +.PHONY : eclipse-generate eclipse-resolve-links + +eclipse-generate: 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" @@ -296,9 +300,19 @@ else $(DOC)-eclipse-customization.xsl $(DOC).xml && \ mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \ cp -rf $(FIGURES) eclipse/$(BASE_DIR)/$(FIGURES) && \ - cd .. + cd ..; + + $(call modify-eclipse) endif +eclipse-resolve-links: + @echo " " + @echo " Using eclipse-help.sed to process external links" + @echo " " + $(foreach FILE, \ + $(wildcard $(DOC)/eclipse/html/$(DOC)/*.html), \ + $(shell sed -i -f tools/eclipse-help.sed $(FILE))) + tarball: html @echo " " @echo " Creating Tarball of document files" -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 19/35] documentation/Makefile: Support for making Eclipse HTML kernel manual
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index d050ddc..3366cad 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -272,7 +272,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:" @@ -281,6 +281,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 @echo " " -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 31/35] documentation/yocto-project-qs/yocto-project-qs.xml: Convert fake-title section into articleinfo
From: Timo Mueller The fake title section is converted into a docbook article.articleinfo. If used with a custom title page this will lead to the excapt same output. But I will enable the creation of metadata from this title information. --- .../yocto-project-qs/yocto-project-qs.xml | 20 ++-- 1 files changed, 14 insertions(+), 6 deletions(-) diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index b1e5df0..856c282 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -3,12 +3,20 @@ [ %poky; ] > - - - -The Yocto Project Quick Start -Copyright © ©RIGHT_YEAR; Linux Foundation - + +The Yocto Project Quick Start + + +©RIGHT_YEAR; +Linux Foundation + + + + + + Welcome! -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 35/35] documentation/Makefile: Clean up eclipse target and update help.
From: Timo Mueller --- documentation/Makefile | 16 1 files changed, 4 insertions(+), 12 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 785c065..7da14a4 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -11,6 +11,8 @@ # or the mega-manual (single, large HTML file comprised of all # Yocto Project manuals). #html: generates an HTML version of a manual. +#eclipse: generates an HTML version of a manual that can be used as +# eclipse help (including necessary metadata files). #tarball: creates a tarball for the doc files. #validate: validates #publish: pushes generated files to the Yocto Project website @@ -275,19 +277,9 @@ eclipse: eclipse-generate eclipse-resolve-links .PHONY : eclipse-generate eclipse-resolve-links eclipse-generate: -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:" +ifeq ($(DOC),mega-manual) @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 " - 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 "ERROR: You cannot generate eclipse documentation for the mega-manual" @echo " " else @echo " " -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 33/35] documentation/tools/eclipse-help.sed: Processes external links for eclipse html files
From: Timo Mueller The file is used when creating eclipse help html files. It processes all html files and converts links so that the user can navigate between different docuementation parts without leaving the eclipse help center. --- documentation/tools/eclipse-help.sed | 18 ++ 1 files changed, 18 insertions(+), 0 deletions(-) create mode 100644 documentation/tools/eclipse-help.sed diff --git a/documentation/tools/eclipse-help.sed b/documentation/tools/eclipse-help.sed new file mode 100644 index 000..71d3395 --- /dev/null +++ b/documentation/tools/eclipse-help.sed @@ -0,0 +1,18 @@ +# Processes poky-ref-manual and yocto-project-qs manual (-- style) +# For example: +# "ulink" href="http://www.yoctoproject.org/docs/1.3/poky-ref-manual/poky-ref-manual.html#faq"; +# -> "link" href="../poky-ref-manual/faq.html" +s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*-[a-z]*\)\/[a-z]*-[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g + +# Processes all other manuals (- style) +# For example: +# "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html#faq"; +# -> "link" href="../kernel-manual/faq.html" +s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*\)\/[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g + +# Process cases where just an external manual is referenced without an id anchor +# For example: +# "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html +# -> "link" href="../kernel-manual/index.html" +s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*-[a-z]*\)\/[a-z]*-[a-z]*-[a-z]*.html\"/\"link\" href=\"\.\.\/\1\/index.html\"/g +s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*\)\/[a-z]*-[a-z]*.html\"/\"link\" href=\"\.\.\/\1\/index.html\"/g -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 14/35] documentation/Makefile: Support for making Eclipse HTML bsp guide
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 148bb51..ea4a6e8 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -276,12 +276,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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 29/35] documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl: new file
From: Timo Mueller 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 | 24 1 files changed, 24 insertions(+), 0 deletions(-) create mode 100644 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl diff --git a/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl b/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl new file mode 100644 index 000..468508b --- /dev/null +++ b/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl @@ -0,0 +1,24 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 0/3][eclipse-poky] Add option to allow building from local repo
From: Timo Mueller Hi, if you build eclipse-poky with the provided build script it will always use the upstream version of the IDE. During development I wanted to use my local repository to make sure that my changes don't break the build system. Therefor I added an option to the build script to allow building from the local eclipse-poky git repository. Best regards, Timo Timo Mueller (3): scripts/build.sh: Added function to use the local repository for building scripts/build.sh: Added help option to the cmdline script/build.sh: Added option to enable building from local repository. scripts/build.sh | 30 ++ 1 files changed, 26 insertions(+), 4 deletions(-) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 1/3] scripts/build.sh: Added function to use the local repository for building
From: Timo Mueller
If USE_LOCAL_GIT_REPO is set to 1 the build scripts uses the local
repository of the eclipse poky project for building instead of the
upstream project. The local repository is derived from the location
for the build script.
---
scripts/build.sh |8
1 files changed, 8 insertions(+), 0 deletions(-)
diff --git a/scripts/build.sh b/scripts/build.sh
index f705546..4ade936 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -65,6 +65,8 @@ check_env ()
fi
}
+USE_LOCAL_GIT_REPO=0
+
if [ $# -ne 2 ] && [ $# -ne 3 ]; then
help
fi
@@ -97,6 +99,12 @@ mkdir ${BUILD_DIR} || fail $? "Create temporary build
directory ${BUILD_DIR}"
#git clone
GIT_URL=git://git.pokylinux.org/eclipse-poky.git
+if [ $USE_LOCAL_GIT_REPO -eq 1 ]; then
+ SCRIPT_DIR=`dirname $0`
+ GIT_DIR=`readlink -f ${SCRIPTDIR}\..`
+ GIT_URL="file://${GIT_DIR}"
+fi
+
GIT_DIR=${BUILD_SRC}
#mkdir ${GIT_DIR}
#cp -r features/ ${GIT_DIR}
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 3/3] script/build.sh: Added option to enable building from local repository.
From: Timo Mueller If the script is called with the -l option the local git repository is used instead of the upstream repository. --- scripts/build.sh |6 +- 1 files changed, 5 insertions(+), 1 deletions(-) diff --git a/scripts/build.sh b/scripts/build.sh index 2d4452e..5dbdd4a 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -7,6 +7,7 @@ help () echo "" echo "Options:" echo "-h - display this help and exit" + echo "-l - use local git repository" echo "BRANCH_NAME - git branch name to build upon" echo "RELEAES_NAME - release name in the final output name" echo "TAG_NAME - git tag name to build upon. defaults to HEAD if not set" @@ -67,11 +68,14 @@ check_env () } USE_LOCAL_GIT_REPO=0 -while getopts ":h" opt; do +while getopts ":lh" opt; do case $opt in h) help ;; + l) + USE_LOCAL_GIT_REPO=1 + ;; esac done shift $(($OPTIND - 1)) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 2/3] scripts/build.sh: Added help option to the cmdline
From: Timo Mueller
Calling the build script with the -h option will now show the usage.
The cmdline parsing can be extended to add new options in the future.
---
scripts/build.sh | 18 ++
1 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/scripts/build.sh b/scripts/build.sh
index 4ade936..2d4452e 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -3,12 +3,13 @@
help ()
{
echo "Build the Yocto Eclipse plugins"
- echo "Usage: $0 ";
+ echo "Usage: $0 [OPTIONS] BRANCH_NAME RELEASE_NAME [TAG_NAME]";
echo ""
echo "Options:"
- echo " - git branch name to build upon"
- echo " - release name in the final output name"
- echo "[tag name] - git tag name to build upon. defaults to master if not set"
+ echo "-h - display this help and exit"
+ echo "BRANCH_NAME - git branch name to build upon"
+ echo "RELEAES_NAME - release name in the final output name"
+ echo "TAG_NAME - git tag name to build upon. defaults to HEAD if not set"
echo ""
echo "Example: $0 master r0 M1.1_rc1";
exit 1;
@@ -66,6 +67,15 @@ check_env ()
}
USE_LOCAL_GIT_REPO=0
+while getopts ":h" opt; do
+ case $opt in
+ h)
+ help
+ ;;
+ esac
+done
+shift $(($OPTIND - 1))
+
if [ $# -ne 2 ] && [ $# -ne 3 ]; then
help
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 2/8] plugins/sdk.ide: Create a default YoctoUIElement from the preference store
From: Atanas Gegov
Adds a method to create a YoctoUIElement that contains the content of
the yocto settings stored in the plugin's default preference store.
---
.../src/org/yocto/sdk/ide/YoctoSDKUtils.java | 25
1 files changed, 25 insertions(+), 0 deletions(-)
diff --git a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
index 749fac7..16035fd 100644
--- a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
+++ b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
@@ -465,6 +465,31 @@ public class YoctoSDKUtils {
return elem;
}
+ /* Load default IDE wide POKY Preference settings into YoctoUIElement */
+ public static YoctoUIElement getDefaultElemFromStore()
+ {
+ IPreferenceStore store =
YoctoSDKPlugin.getDefault().getPreferenceStore();
+ YoctoUIElement elem = new YoctoUIElement();
+ if
(store.getDefaultString(PreferenceConstants.SDK_MODE).equals(IPreferenceStore.TRUE))
+
elem.setEnumPokyMode(YoctoUIElement.PokyMode.POKY_SDK_MODE);
+ else
+
elem.setEnumPokyMode(YoctoUIElement.PokyMode.POKY_TREE_MODE);
+
+
elem.setStrToolChainRoot(store.getDefaultString(PreferenceConstants.TOOLCHAIN_ROOT));
+
elem.setStrTarget(store.getDefaultString(PreferenceConstants.TOOLCHAIN_TRIPLET));
+
elem.setIntTargetIndex(store.getDefaultInt(PreferenceConstants.TARGET_ARCH_INDEX));
+
elem.setStrQemuKernelLoc(store.getDefaultString(PreferenceConstants.QEMU_KERNEL));
+
elem.setStrQemuOption(store.getDefaultString(PreferenceConstants.QEMU_OPTION));
+
elem.setStrSysrootLoc(store.getDefaultString(PreferenceConstants.SYSROOT));
+
+ if
(store.getDefaultString(PreferenceConstants.TARGET_MODE).equals(IPreferenceStore.TRUE))
+
elem.setEnumDeviceMode(YoctoUIElement.DeviceMode.QEMU_MODE);
+ else
+
elem.setEnumDeviceMode(YoctoUIElement.DeviceMode.DEVICE_MODE);
+
+ return elem;
+ }
+
public static String qemuTargetTranslate(String strTargetArch)
{
String qemu_target = "";
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 0/8][eclipse-poky] Enable setting yocto settings in the project properties dialog
From: Timo Mueller Hi, changing the yocto settings of a project is currently achieved through a separate dialog. This dialog can be opened via the eclipse menu bar (project -> change yocto project settings). Typically all project related settings in eclipse are located in the project properties dialog. This patch series adds yocto settings to the project properties dialog. It also removes the separate dialog. Instead the yocto section in the project properties is opened if "change yocto project settings" is selected from the menu bar. Best regards, Atanas and Timo Atanas Gegov (4): plugins/sdk.ide: Allow using a YoctoUIElement to set the input of a yocto settings widget plugins/sdk.ide: Create a default YoctoUIElement from the preference store plugins/sdk.ide: Use new setCurrentInput method to set defaults plugins/sdk.ide: Remove fControl array that is no longer needed Timo Mueller (4): plugins/sdk.ide: Added empty yocto preference page to project properties plugins/sdk.ide: Move modification of yocto project settings to utils class plugins/sdk.ide: Show yocto ui setting widget in project property page plugins/sdk.ide: Open project properties instead of standalone yocto settings dialog .../OSGI-INF/l10n/bundle.properties|1 + plugins/org.yocto.sdk.ide/plugin.xml | 14 +++ .../src/org/yocto/sdk/ide/YoctoSDKUtils.java | 67 .../src/org/yocto/sdk/ide/YoctoUISetting.java | 54 +++--- .../yocto/sdk/ide/actions/ReconfigYoctoAction.java | 64 ++- .../yocto/sdk/ide/actions/SDKLocationDialog.java | 89 .../ide/preferences/YoctoSDKPreferencePage.java| 51 +- .../preferences/YoctoSDKProjectPropertyPage.java | 111 8 files changed, 247 insertions(+), 204 deletions(-) delete mode 100644 plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/SDKLocationDialog.java create mode 100644 plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 3/8] plugins/sdk.ide: Use new setCurrentInput method to set defaults
From: Atanas Gegov
Removes the error prone method of using the fControls array and uses
the new YoctoUIElement interface.
Improved method of setting default preferences (globally)
---
.../ide/preferences/YoctoSDKPreferencePage.java| 51 +--
1 files changed, 3 insertions(+), 48 deletions(-)
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKPreferencePage.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKPreferencePage.java
index b75bdc1..d1c1a72 100644
---
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKPreferencePage.java
+++
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKPreferencePage.java
@@ -89,58 +89,13 @@ public class YoctoSDKPreferencePage extends PreferencePage
implements IWorkbench
return false;
}
}
-
+
/*
* @see PreferencePage#performDefaults()
*/
protected void performDefaults() {
- IPreferenceStore store= getPreferenceStore();
- ArrayList arrControls =
this.yoctoUISetting.getfControls();
-
- for (int i = 0; i < arrControls.size(); i++)
- {
- Control control = arrControls.get(i);
- String[] controlData = (String[])control.getData();
- String sKey = controlData[0];
- if (control instanceof Button)
- {
- sKey = sKey.substring(0, sKey.lastIndexOf("_"));
- }
- String sValue = store.getDefaultString(sKey);
- if (control instanceof Button)
- {
- if (sValue.equalsIgnoreCase("true"))
- {
- if (controlData[0].endsWith("_1"))
//the 1st radio button of the group
-
((Button)control).setSelection(true);
- else
-
((Button)control).setSelection(false);//the 2nd radio button of the group
- }
- else
- {
- if (controlData[0].endsWith("_1"))
//the 1st radio button of the group
-
((Button)control).setSelection(false);
- else
-
((Button)control).setSelection(true);//the 2nd radio button of the group
- }
- }
- else if (control instanceof Text)
- {
- ((Text)control).setText(sValue);
- }
- else if (control instanceof Combo)
- {
- if (!sValue.isEmpty())
-
((Combo)control).select(Integer.valueOf(sValue).intValue());
- }
- }
-
- try {
-
yoctoUISetting.validateInput(SDKCheckRequestFrom.Preferences, false);
- } catch (YoctoGeneralException e) {
- System.out.println("Have you ever set Yocto Project
Reference before?");
- System.out.println(e.getMessage());
- }
+ YoctoUIElement defaultElement =
YoctoSDKUtils.getDefaultElemFromStore();
+ yoctoUISetting.setCurrentInput(defaultElement);
super.performDefaults();
}
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 1/8] plugins/sdk.ide: Allow using a YoctoUIElement to set the input of a yocto settings widget
From: Atanas Gegov
Currently a YoctoUIElement is used to create a YoctoUISetting
widget. It is also possible to retrieve a YoctoUIElement containing
the current input of the widget. This patch adds the capability to
also set the input of the widget using a YoctoUIElement. Instead of
using the fControl array clients can now use this method to set the
input of the widget.
---
.../src/org/yocto/sdk/ide/YoctoUISetting.java | 40
1 files changed, 40 insertions(+), 0 deletions(-)
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
index b4625f6..53af8f0 100644
--- a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
+++ b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
@@ -307,6 +307,46 @@ public class YoctoUISetting {
return elem;
}
+ public void setCurrentInput(YoctoUIElement elem){
+ btnSDKRoot.setSelection(false);
+ btnPokyRoot.setSelection(false);
+
if(elem.getEnumPokyMode().equals(YoctoUIElement.PokyMode.POKY_SDK_MODE)){
+ btnSDKRoot.setSelection(true);
+ }
+ else
if(elem.getEnumPokyMode().equals(YoctoUIElement.PokyMode.POKY_TREE_MODE)){
+ btnPokyRoot.setSelection(true);
+ }
+
+ btnQemu.setSelection(false);
+ btnDevice.setSelection(false);
+
if(elem.getEnumDeviceMode().equals(YoctoUIElement.DeviceMode.QEMU_MODE)){
+ btnQemu.setSelection(true);
+ }
+ else
if(elem.getEnumDeviceMode().equals(YoctoUIElement.DeviceMode.DEVICE_MODE)){
+ btnDevice.setSelection(true);
+ }
+
+ textRootLoc.setText(elem.getStrToolChainRoot());
+ targetArchCombo.select(elem.getIntTargetIndex());
+ if(elem.getStrTargetsArray() == null){
+ targetArchCombo.setItems(new String[]{});
+ }
+ else {
+ targetArchCombo.setItems(elem.getStrTargetsArray());
+ }
+ targetArchCombo.setText(elem.getStrTarget());
+ textKernelLoc.setText(elem.getStrQemuKernelLoc());
+ textQemuOption.setText(elem.getStrQemuOption());
+ textSysrootLoc.setText(elem.getStrSysrootLoc());
+
+ try {
+ validateInput(SDKCheckRequestFrom.Preferences, false);
+ } catch (YoctoGeneralException e) {
+ System.out.println("Have you ever set Yocto Project
Reference before?");
+ System.out.println(e.getMessage());
+ }
+ }
+
public boolean validateInput(SDKCheckRequestFrom from, boolean bPrompt)
throws YoctoGeneralException {
YoctoUIElement elem = getCurrentInput();
boolean pass = true;
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 4/8] plugins/sdk.ide: Remove fControl array that is no longer needed
From: Atanas Gegov
The setCurrentInput method replaces the functionality that was
provided by the fControl array.
---
.../src/org/yocto/sdk/ide/YoctoUISetting.java | 14 --
1 files changed, 0 insertions(+), 14 deletions(-)
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
index 53af8f0..0fbfde0 100644
--- a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
+++ b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoUISetting.java
@@ -43,7 +43,6 @@ import org.yocto.sdk.ide.preferences.PreferenceConstants;
public class YoctoUISetting {
private static final String ENV_SCRIPT_FILE_PREFIX =
"environment-setup-";
- private ArrayList fControls;
private SelectionListener fSelectionListener;
private ModifyListener fModifyListener;
@@ -66,7 +65,6 @@ public class YoctoUISetting {
public YoctoUISetting(YoctoUIElement elem)
{
- fControls = new ArrayList();
yoctoUIElement = elem;
elem.setStrTargetsArray(getTargetArray(elem));
@@ -88,11 +86,8 @@ public class YoctoUISetting {
private Control addControls(Control fControl, final String sKey, String
sValue)
{
-
fControl.setData(new String[]{sKey,sValue});
- fControls.add(fControl);
return fControl;
-
}
private Control addRadioButton(Composite parent, String label, String
key, boolean bSelected) {
@@ -375,15 +370,6 @@ public class YoctoUISetting {
return pass;
}
-
- public void setfControls(ArrayList fControls) {
- this.fControls = fControls;
- }
-
- public ArrayList getfControls() {
- return fControls;
- }
-
private void updateQemuControlState()
{
boolean bQemuMode = btnQemu.getSelection();
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 7/8] plugins/sdk.ide: Show yocto ui setting widget in project property page
From: Timo Mueller
The yocto property page in a project's properties dialog will now show
the yocto settings that are also used in the global yocto preferences
dialog. On save the defined values will be stored to the project's
environment.
---
.../preferences/YoctoSDKProjectPropertyPage.java | 88 +++-
1 files changed, 85 insertions(+), 3 deletions(-)
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
index 265c8dc..92d476a 100644
---
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
+++
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
@@ -1,5 +1,6 @@
/***
* Copyright (c) 2012 BMW Car IT GmbH.
+ * Copyright (c) 2010 Intel.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -7,23 +8,104 @@
*
* Contributors:
* BMW Car IT GmbH - initial implementation
+ * Intel - initial API implementation (copied from YoctoSDKPreferencePage)
***/
package org.yocto.sdk.ide.preferences;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.runtime.IAdaptable;
+import org.eclipse.jface.dialogs.Dialog;
+import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.IWorkbenchPropertyPage;
import org.eclipse.ui.dialogs.PropertyPage;
+import org.yocto.sdk.ide.YoctoGeneralException;
+import org.yocto.sdk.ide.YoctoSDKUtils;
+import org.yocto.sdk.ide.YoctoSDKUtils.SDKCheckRequestFrom;
+import org.yocto.sdk.ide.YoctoUIElement;
+import org.yocto.sdk.ide.YoctoUISetting;
public class YoctoSDKProjectPropertyPage extends PropertyPage implements
IWorkbenchPropertyPage {
- public YoctoSDKProjectPropertyPage() {
- }
+ private YoctoUISetting yoctoUISetting;
+ private IProject project = null;
@Override
protected Control createContents(Composite parent) {
- return null;
+ YoctoUIElement uiElement = loadUIElement();
+ this.yoctoUISetting = new YoctoUISetting(uiElement);
+
+ initializeDialogUnits(parent);
+ final Composite result = new Composite(parent, SWT.NONE);
+
+ try {
+ yoctoUISetting.createComposite(result);
+ yoctoUISetting
+
.validateInput(SDKCheckRequestFrom.Preferences, false);
+ Dialog.applyDialogFont(result);
+ return result;
+ } catch (YoctoGeneralException e) {
+ System.out.println("Have you ever set Yocto Project
Reference before?");
+ System.out.println(e.getMessage());
+ return result;
+ }
+ }
+
+ private IProject getProject() {
+ if (project != null) {
+ return project;
+ }
+
+ IAdaptable adaptable = getElement();
+ if (adaptable == null) {
+ throw new IllegalStateException("Project can only be
retrieved after properties page has been set up.");
+ }
+
+ project = (IProject) adaptable.getAdapter(IProject.class);
+ return project;
+ }
+
+ private YoctoUIElement loadUIElement() {
+ YoctoUIElement uiElement =
YoctoSDKUtils.getElemFromProjectEnv(getProject());
+
+ if (uiElement.getStrToolChainRoot().isEmpty()
+ || uiElement.getStrTarget().isEmpty()) {
+ // No project environment has been set yet, use the
Preference
+ // values
+ uiElement = YoctoSDKUtils.getElemFromStore();
+ }
+
+ return uiElement;
+ }
+
+ /*
+* @see PreferencePage#performDefaults()
+*/
+ @Override
+ protected void performDefaults() {
+ YoctoUIElement defaultElement =
YoctoSDKUtils.getDefaultElemFromStore();
+ yoctoUISetting.setCurrentInput(defaultElement);
+ super.performDefaults();
}
+ /*
+* @see IPreferencePage#performOk()
+*/
+ @Override
+ public boolean performOk() {
+ try {
+
yoctoUISetting.validateInput(SDKCheckRequestFrom.Preferences, true);
+
+ YoctoUIElement elem = yoctoUISetting.getCurrentInput();
+ Yoct
[yocto] [PATCH 6/8] plugins/sdk.ide: Move modification of yocto project settings to utils class
From: Timo Mueller
Saving yocto project settings is currently only used by the "Change
Yocto Project Settings" command. To allow other UI elements
(e.g. project property pages) to modify the yocto settings of a
project the functionality has been extraced to a separate method and
moved to the utils class.
---
.../src/org/yocto/sdk/ide/YoctoSDKUtils.java | 42
.../yocto/sdk/ide/actions/ReconfigYoctoAction.java | 41 ++-
2 files changed, 46 insertions(+), 37 deletions(-)
diff --git a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
index 16035fd..7ea4262 100644
--- a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
+++ b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/YoctoSDKUtils.java
@@ -22,10 +22,12 @@ import java.util.HashMap;
import java.util.Iterator;
import org.eclipse.cdt.core.CCorePlugin;
+import org.eclipse.cdt.core.ConsoleOutputStream;
import org.eclipse.cdt.core.envvar.IContributedEnvironment;
import org.eclipse.cdt.core.envvar.IEnvironmentVariable;
import org.eclipse.cdt.core.envvar.IEnvironmentVariableManager;
import org.eclipse.cdt.core.model.CoreModel;
+import org.eclipse.cdt.core.resources.IConsole;
import org.eclipse.cdt.core.settings.model.ICConfigurationDescription;
import org.eclipse.cdt.core.settings.model.ICProjectDescription;
import org.eclipse.core.resources.IProject;
@@ -75,6 +77,7 @@ public class YoctoSDKUtils {
private static final String DEFAULT_SYSROOT_PREFIX = "--sysroot=";
private static final String LIBTOOL_SYSROOT_PREFIX =
"--with-libtool-sysroot=";
private static final String SYSROOTS_DIR = "sysroots";
+ private static final String CONSOLE_MESSAGE =
"Menu.SDK.Console.Configure.Message";
public static SDKCheckResults checkYoctoSDK(YoctoUIElement elem) {
@@ -418,6 +421,45 @@ public class YoctoSDKUtils {
elem.setEnumDeviceMode(YoctoUIElement.DeviceMode.DEVICE_MODE);
return elem;
}
+
+ /* Save YoctoUIElement to project settings */
+ public static void saveElemToProjectEnv(IProject project,
YoctoUIElement elem)
+ {
+ ConsoleOutputStream consoleOutStream = null;
+
+ try {
+ YoctoSDKProjectNature.setEnvironmentVariables(project,
elem);
+
YoctoSDKProjectNature.configureAutotoolsOptions(project);
+ IConsole console =
CCorePlugin.getDefault().getConsole("org.yocto.sdk.ide.YoctoConsole");
+ console.start(project);
+ consoleOutStream = console.getOutputStream();
+ String messages =
YoctoSDKMessages.getString(CONSOLE_MESSAGE);
+ consoleOutStream.write(messages.getBytes());
+ }
+ catch (CoreException e)
+ {
+ System.out.println(e.getMessage());
+ }
+ catch (IOException e)
+ {
+ System.out.println(e.getMessage());
+ }
+ catch (YoctoGeneralException e)
+ {
+ System.out.println(e.getMessage());
+ }
+ finally {
+ if (consoleOutStream != null) {
+ try {
+ consoleOutStream.flush();
+ consoleOutStream.close();
+ }
+ catch (IOException e) {
+ // ignore
+ }
+ }
+ }
+ }
/* Load IDE wide POKY Preference settings into Preference Store */
public static void saveElemToStore(YoctoUIElement elem)
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
index f68b552..d7021be 100644
---
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
+++
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
@@ -10,29 +10,19 @@
***/
package org.yocto.sdk.ide.actions;
-import java.io.IOException;
-
-import org.eclipse.cdt.core.CCorePlugin;
-import org.eclipse.cdt.core.ConsoleOutputStream;
-import org.eclipse.cdt.core.resources.IConsole;
+import org.eclipse.cdt.internal.autotools.ui.actions.InvokeAction;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IProject;
-import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.action.IAction;
-import org.eclipse.cdt.internal.autotool
[yocto] [PATCH 5/8] plugins/sdk.ide: Added empty yocto preference page to project properties
From: Timo Mueller
Adds an empty preference page to projects with the YoctoSDKNature. This
preference page is shown in the standard project properties dialog and
will later allow modifying the yocto settings of the project.
---
.../OSGI-INF/l10n/bundle.properties|1 +
plugins/org.yocto.sdk.ide/plugin.xml | 14 +
.../preferences/YoctoSDKProjectPropertyPage.java | 29
3 files changed, 44 insertions(+), 0 deletions(-)
create mode 100644
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
diff --git a/plugins/org.yocto.sdk.ide/OSGI-INF/l10n/bundle.properties
b/plugins/org.yocto.sdk.ide/OSGI-INF/l10n/bundle.properties
index d0bf9b7..a7172be 100644
--- a/plugins/org.yocto.sdk.ide/OSGI-INF/l10n/bundle.properties
+++ b/plugins/org.yocto.sdk.ide/OSGI-INF/l10n/bundle.properties
@@ -5,5 +5,6 @@ command.name = ReconfigureYoctoProject
command.label.0 = Change Yocto Project Settings
command.mnemonic = C
projectType.name.0 = Yocto Project ADT Project
+projectProperties.label.0 = Yocto Project Settings
Bundle-Vendor = yoctoproject.org
Bundle-Name = Yocto Plugin IDE
diff --git a/plugins/org.yocto.sdk.ide/plugin.xml
b/plugins/org.yocto.sdk.ide/plugin.xml
index c540b9b..6548ae2 100644
--- a/plugins/org.yocto.sdk.ide/plugin.xml
+++ b/plugins/org.yocto.sdk.ide/plugin.xml
@@ -180,5 +180,19 @@
id="org.yocto.sdk.ide.YoctoConsole">
+
+
+
+
+
+
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
new file mode 100644
index 000..265c8dc
--- /dev/null
+++
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/preferences/YoctoSDKProjectPropertyPage.java
@@ -0,0 +1,29 @@
+/***
+ * Copyright (c) 2012 BMW Car IT GmbH.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * BMW Car IT GmbH - initial implementation
+
***/
+package org.yocto.sdk.ide.preferences;
+
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Control;
+import org.eclipse.ui.IWorkbenchPropertyPage;
+import org.eclipse.ui.dialogs.PropertyPage;
+
+public class YoctoSDKProjectPropertyPage extends PropertyPage implements
+ IWorkbenchPropertyPage {
+
+ public YoctoSDKProjectPropertyPage() {
+ }
+
+ @Override
+ protected Control createContents(Composite parent) {
+ return null;
+ }
+
+}
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 8/8] plugins/sdk.ide: Open project properties instead of standalone yocto settings dialog
From: Timo Mueller
As the yocto settings can now be set via the project's property pages,
the "Change Yocto Project Settings" will now open the property page
instead of showing the a standalone dialog.
---
.../yocto/sdk/ide/actions/ReconfigYoctoAction.java | 29 ++
.../yocto/sdk/ide/actions/SDKLocationDialog.java | 89
2 files changed, 10 insertions(+), 108 deletions(-)
delete mode 100644
plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/SDKLocationDialog.java
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
index d7021be..e255fd1 100644
---
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
+++
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/ReconfigYoctoAction.java
@@ -14,16 +14,13 @@ import
org.eclipse.cdt.internal.autotools.ui.actions.InvokeAction;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IProject;
import org.eclipse.jface.action.IAction;
-import org.eclipse.swt.widgets.Shell;
-import org.yocto.sdk.ide.YoctoSDKMessages;
-import org.yocto.sdk.ide.YoctoSDKUtils;
-import org.yocto.sdk.ide.YoctoUIElement;
+import org.eclipse.jface.preference.PreferenceDialog;
+import org.eclipse.ui.dialogs.PreferencesUtil;
+import org.yocto.sdk.ide.YoctoSDKPlugin;
@SuppressWarnings("restriction")
public class ReconfigYoctoAction extends InvokeAction {
-private static final String DIALOG_TITLE = "Menu.SDK.Dialog.Title";
-
public void run(IAction action) {
IContainer container = getSelectedContainer();
@@ -32,19 +29,13 @@ public class ReconfigYoctoAction extends InvokeAction {
IProject project = container.getProject();
- //Try to get the per project configuration first
- YoctoUIElement elem =
YoctoSDKUtils.getElemFromProjectEnv(project);
- if (elem.getStrToolChainRoot().isEmpty()||
elem.getStrTarget().isEmpty()){
- // No project environment has been set yet, use the
Preference values
- elem = YoctoSDKUtils.getElemFromStore();
- }
-
- SDKLocationDialog optionDialog = new SDKLocationDialog(new
Shell(), YoctoSDKMessages.getString(DIALOG_TITLE), elem);
- optionDialog.open();
- elem = optionDialog.getElem();
- if (elem.getStrToolChainRoot() != null) {
- YoctoSDKUtils.saveElemToProjectEnv(project, elem);
- }
+ PreferenceDialog dialog =
+
PreferencesUtil.createPropertyDialogOn(YoctoSDKPlugin.getActiveWorkbenchShell(),
+
project,
+
"org.yocto.sdk.ide.page",
+
null,
+
null);
+ dialog.open();
}
public void dispose() {
diff --git
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/SDKLocationDialog.java
b/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/SDKLocationDialog.java
deleted file mode 100644
index 439d720..000
---
a/plugins/org.yocto.sdk.ide/src/org/yocto/sdk/ide/actions/SDKLocationDialog.java
+++ /dev/null
@@ -1,89 +0,0 @@
-/***
- * Copyright (c) 2010 Intel Corporation.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Intel - initial API and implementation
-
***/
-package org.yocto.sdk.ide.actions;
-
-import org.eclipse.jface.dialogs.Dialog;
-import org.eclipse.jface.dialogs.IDialogConstants;
-
-import org.eclipse.swt.SWT;
-import org.eclipse.swt.widgets.Composite;
-import org.eclipse.swt.widgets.Control;
-import org.eclipse.swt.widgets.Shell;
-
-import org.yocto.sdk.ide.YoctoGeneralException;
-import org.yocto.sdk.ide.YoctoSDKUtils.SDKCheckRequestFrom;
-import org.yocto.sdk.ide.YoctoUIElement;
-import org.yocto.sdk.ide.YoctoUISetting;
-
-public class SDKLocationDialog extends Dialog {
- private String title;
- private YoctoUISetting yoctoUISetting;
- private YoctoUIElement elem;
-
- public SDKLocationDialog(Shell parentShell, String dialogTitle,
YoctoUIElement elem) {
-super
[yocto] [PATCH 0/3][yocto-docs] Collected fixes to the eclipe help generation
From: Timo Mueller Hi, these are some minor fixes for the eclipse help generation currently located in the timo branch of the yocto-docs repository. 1: Fixes an issue with the figures folder when eclipse target was called consecutively without cleaning in between 2: Whitespace fix 3: Enable chunk.quietly to provide cleaner console logs Best regards, Timo Timo Mueller (3): documentation/Makefile: Fix copying of figures folder documentation/tools/eclipse-help.sed: Fix whitespace documentation: Add chunk.quietly option to eclipse processing documentation/Makefile |2 +- .../adt-manual-eclipse-customization.xsl |1 + .../bsp-guide/bsp-guide-eclipse-customization.xsl |1 + .../dev-manual-eclipse-customization.xsl |1 + .../kernel-manual-eclipse-customization.xsl|1 + .../poky-ref-manual-eclipse-customization.xsl |1 + documentation/tools/eclipse-help.sed |4 ++-- .../yocto-project-qs-eclipse-customization.xsl |1 + 8 files changed, 9 insertions(+), 3 deletions(-) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 1/3] documentation/Makefile: Fix copying of figures folder
From: Timo Mueller When calling the eclipse target twice without calling clean in between the figures folder was copied as a subfolder of the existing figures folder. This patch fixes the copy command to correctly copy the figures folder. --- documentation/Makefile |2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 7da14a4..ddef079 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -291,7 +291,7 @@ else -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) && \ + cp -rf $(FIGURES) eclipse/$(BASE_DIR) && \ cd ..; $(call modify-eclipse) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 2/3] documentation/tools/eclipse-help.sed: Fix whitespace
From: Timo Mueller --- documentation/tools/eclipse-help.sed |4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/tools/eclipse-help.sed b/documentation/tools/eclipse-help.sed index 71d3395..38690bc 100644 --- a/documentation/tools/eclipse-help.sed +++ b/documentation/tools/eclipse-help.sed @@ -1,12 +1,12 @@ # Processes poky-ref-manual and yocto-project-qs manual (-- style) # For example: -# "ulink" href="http://www.yoctoproject.org/docs/1.3/poky-ref-manual/poky-ref-manual.html#faq"; +# "ulink" href="http://www.yoctoproject.org/docs/1.3/poky-ref-manual/poky-ref-manual.html#faq"; # -> "link" href="../poky-ref-manual/faq.html" s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*-[a-z]*\)\/[a-z]*-[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g # Processes all other manuals (- style) # For example: -# "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html#faq"; +# "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html#faq"; # -> "link" href="../kernel-manual/faq.html" s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*\)\/[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 3/3] documentation: Add chunk.quietly option to eclipse processing
From: Timo Mueller The chunk.quietly option disables the output of the docbook chunker. Creation of a new html file is now longer printed to the console. This provides a much cleaner output of the eclipse makefile target. --- .../adt-manual-eclipse-customization.xsl |1 + .../bsp-guide/bsp-guide-eclipse-customization.xsl |1 + .../dev-manual-eclipse-customization.xsl |1 + .../kernel-manual-eclipse-customization.xsl|1 + .../poky-ref-manual-eclipse-customization.xsl |1 + .../yocto-project-qs-eclipse-customization.xsl |1 + 6 files changed, 6 insertions(+), 0 deletions(-) diff --git a/documentation/adt-manual/adt-manual-eclipse-customization.xsl b/documentation/adt-manual/adt-manual-eclipse-customization.xsl index ff1464e..d16ffbb 100644 --- a/documentation/adt-manual/adt-manual-eclipse-customization.xsl +++ b/documentation/adt-manual/adt-manual-eclipse-customization.xsl @@ -9,6 +9,7 @@ href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + diff --git a/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl index b9aceb2..1c80bee 100644 --- a/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl +++ b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl @@ -9,6 +9,7 @@ href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + diff --git a/documentation/dev-manual/dev-manual-eclipse-customization.xsl b/documentation/dev-manual/dev-manual-eclipse-customization.xsl index ff1de89..8ac4c18 100644 --- a/documentation/dev-manual/dev-manual-eclipse-customization.xsl +++ b/documentation/dev-manual/dev-manual-eclipse-customization.xsl @@ -9,6 +9,7 @@ href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + diff --git a/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl b/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl index 70a1e19..7992173 100644 --- a/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl +++ b/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl @@ -9,6 +9,7 @@ href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + diff --git a/documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl b/documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl index 4e31193..3412208 100644 --- a/documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl +++ b/documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl @@ -9,6 +9,7 @@ href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + diff --git a/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl b/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl index 468508b..f8f8930 100644 --- a/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl +++ b/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl @@ -10,6 +10,7 @@ + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFCv3 1/7] plugins/sdk.ide.doc.user: Add empty eclipse help
From: Timo Mueller Adds yocto specific eclipse help to the plugin. The help is currently empty but will contain the official yocto documentation later. --- .../META-INF/MANIFEST.MF |3 ++- .../org.yocto.sdk.ide.doc.user/build.properties|7 +-- plugins/org.yocto.sdk.ide.doc.user/html/book.css |1 + plugins/org.yocto.sdk.ide.doc.user/plugin.xml |7 +++ plugins/org.yocto.sdk.ide.doc.user/toc.xml |3 +++ 5 files changed, 18 insertions(+), 3 deletions(-) create mode 100644 plugins/org.yocto.sdk.ide.doc.user/html/book.css create mode 100644 plugins/org.yocto.sdk.ide.doc.user/toc.xml diff --git a/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF b/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF index 87079ce..a93601e 100644 --- a/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF +++ b/plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF @@ -5,4 +5,5 @@ Bundle-SymbolicName: org.yocto.sdk.ide.doc.user;singleton:=true Bundle-Version: 1.2.0.qualifier Bundle-Vendor: %Bundle-Vendor Bundle-RequiredExecutionEnvironment: JavaSE-1.6 -Require-Bundle: org.eclipse.ui.cheatsheets +Require-Bundle: org.eclipse.ui.cheatsheets, + org.eclipse.help diff --git a/plugins/org.yocto.sdk.ide.doc.user/build.properties b/plugins/org.yocto.sdk.ide.doc.user/build.properties index caf850b..6d00e58 100644 --- a/plugins/org.yocto.sdk.ide.doc.user/build.properties +++ b/plugins/org.yocto.sdk.ide.doc.user/build.properties @@ -2,5 +2,8 @@ bin.includes = plugin.xml,\ .,\ META-INF/,\ OSGI-INF/,\ - cheatsheets/ -src.includes = cheatsheets/ + cheatsheets/,\ + html/,\ + toc.xml +src.includes = cheatsheets/,\ + html/ diff --git a/plugins/org.yocto.sdk.ide.doc.user/html/book.css b/plugins/org.yocto.sdk.ide.doc.user/html/book.css new file mode 100644 index 000..e248f5a --- /dev/null +++ b/plugins/org.yocto.sdk.ide.doc.user/html/book.css @@ -0,0 +1 @@ +@import "PLUGINS_ROOT/PRODUCT_PLUGIN/book.css"; diff --git a/plugins/org.yocto.sdk.ide.doc.user/plugin.xml b/plugins/org.yocto.sdk.ide.doc.user/plugin.xml index 24c539d..59ae9d1 100644 --- a/plugins/org.yocto.sdk.ide.doc.user/plugin.xml +++ b/plugins/org.yocto.sdk.ide.doc.user/plugin.xml @@ -10,4 +10,11 @@ name="%cheatsheet.name"> + + + + diff --git a/plugins/org.yocto.sdk.ide.doc.user/toc.xml b/plugins/org.yocto.sdk.ide.doc.user/toc.xml new file mode 100644 index 000..e110a54 --- /dev/null +++ b/plugins/org.yocto.sdk.ide.doc.user/toc.xml @@ -0,0 +1,3 @@ + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFCv3 0/7][eclipse-poky] Integrate yocto documentation into eclipse
From: Timo Mueller Hi, since the last proposal some things have changed: 1. Eclipse help generation is now part of the yocto-docs project (currently available in the origin/timo branch) 2. We agreed that the plugin should be licensed under the EPL v1.0 instead of having a separate documentation plugin licensed under the CCA-SA 2.0 UK. The last patch set was adding generated eclipse help files (html) to the repository. One major change in this patch series is that I extended the plugin build system to integrate the generation into the build process. Thus keeping the eclipse help and the official documentation in sync is now automated. Also the eclipse help is now part of the user.doc plugin and no longer contained in a separate plugin/feature. Rational from the original patch: the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide. I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Best regards Timo Timo Mueller (7): plugins/sdk.ide.doc.user: Add empty eclipse help plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation scripts/generate_doc.sh: Add script to handle eclipse help generation plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents scripts/generat-doc.sh: Copy generated eclipse help into the user.doc plugin scripts/build.sh: Add documentation generation to the default build (TEMPORARY): Use origin/timo branch of yocto docs project .../META-INF/MANIFEST.MF |3 +- plugins/org.yocto.sdk.ide.doc.user/about.html.in | 166 .../org.yocto.sdk.ide.doc.user/build.properties|9 +- plugins/org.yocto.sdk.ide.doc.user/html/book.css |1 + plugins/org.yocto.sdk.ide.doc.user/plugin.xml | 31 plugins/org.yocto.sdk.ide.doc.user/toc.xml | 21 +++ scripts/build.sh |7 + scripts/generate_doc.sh| 91 +++ 8 files changed, 326 insertions(+), 3 deletions(-) create mode 100644 plugins/org.yocto.sdk.ide.doc.user/about.html.in create mode 100644 plugins/org.yocto.sdk.ide.doc.user/html/book.css create mode 100644 plugins/org.yocto.sdk.ide.doc.user/toc.xml create mode 100755 scripts/generate_doc.sh -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFCv3 4/7] plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents
From: Timo Mueller The separate yocto manuals are added to the table of contents to prepare their inclusion into the plugin. --- plugins/org.yocto.sdk.ide.doc.user/plugin.xml | 24 plugins/org.yocto.sdk.ide.doc.user/toc.xml| 18 ++ 2 files changed, 42 insertions(+), 0 deletions(-) diff --git a/plugins/org.yocto.sdk.ide.doc.user/plugin.xml b/plugins/org.yocto.sdk.ide.doc.user/plugin.xml index 59ae9d1..16ac67e 100644 --- a/plugins/org.yocto.sdk.ide.doc.user/plugin.xml +++ b/plugins/org.yocto.sdk.ide.doc.user/plugin.xml @@ -16,5 +16,29 @@ file="toc.xml" primary="true"> + + + + + + + + + + + + diff --git a/plugins/org.yocto.sdk.ide.doc.user/toc.xml b/plugins/org.yocto.sdk.ide.doc.user/toc.xml index e110a54..b5ebc43 100644 --- a/plugins/org.yocto.sdk.ide.doc.user/toc.xml +++ b/plugins/org.yocto.sdk.ide.doc.user/toc.xml @@ -1,3 +1,21 @@ + + + + + + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFCv3 3/7] scripts/generate_doc.sh: Add script to handle eclipse help generation
From: Timo Mueller
This script will checkout the yocto-docs project containing the
official yocto documentation. After successful checkout the eclipse
help is generated and the about.html file of the doc.user plugin is
created.
---
scripts/generate_doc.sh | 84 +++
1 files changed, 84 insertions(+), 0 deletions(-)
create mode 100755 scripts/generate_doc.sh
diff --git a/scripts/generate_doc.sh b/scripts/generate_doc.sh
new file mode 100755
index 000..faab9ef
--- /dev/null
+++ b/scripts/generate_doc.sh
@@ -0,0 +1,84 @@
+#!/bin/sh
+
+help()
+{
+ echo "Generate and add eclipse help from yocto's documentation"
+ echo "Usage: $0 BRANCH_NAME PLUGIN_FOLDER"
+ echo " $0 -t TAG_NAME PLUGIN_FOLDER"
+ echo ""
+ echo "Options:"
+ echo "-h - display this help and exit"
+ echo "-t TAG_NAME - tag to build the documentation upon"
+ echo "BRANCH_NAME - branch to build the documentation upon"
+ echo "PLUGIN_FOLDER - root folder of the eclipse-poky project"
+ exit 1
+}
+
+fail ()
+{
+ local retval=$1
+ shift $1
+ echo "[Fail $retval]: $*"
+ echo "BUILD_TOP=${BUILD_TOP}"
+ cd ${TOP}
+ exit ${retval}
+}
+
+CHECKOUT_TAG=0
+while getopts ":ht" opt; do
+ case $opt in
+ h)
+ help
+ ;;
+ t)
+ CHECKOUT_TAG=1
+ ;;
+ esac
+done
+shift $(($OPTIND - 1))
+
+if [ $# -ne 2 ]; then
+ help
+fi
+
+if [ $CHECKOUT_TAG -eq 0 ]; then
+ REFERENCE=origin/$1
+else
+ REFERENCE=$1
+fi
+PLUGIN_FOLDER=$2
+
+TOP=`pwd`
+
+DOC_DIR=${PLUGIN_FOLDER}/docs
+rm -rf ${DOC_DIR}
+DOC_PLUGIN_DIR=${PLUGIN_FOLDER}/plugins/org.yocto.sdk.ide.doc.user
+DOC_HTML_DIR=${DOC_PLUGIN_DIR}/html/
+
+# git clone
+DOC_GIT=git://git.yoctoproject.org/yocto-docs.git
+git clone ${DOC_GIT} ${DOC_DIR} || fail $? "git clone ${DOC_GIT}"
+cd ${DOC_DIR}
+git checkout ${REFERENCE} || fail $? "git checkout ${REFERENCE}"
+COMMIT_ID=`git rev-parse HEAD`
+
+# build and copy
+DOCS="yocto-project-qs adt-manual kernel-manual \
+ bsp-guide poky-ref-manual dev-manual"
+
+cd documentation
+ECLIPSE_TARGET_AVAILABLE=`make -q eclipse &> /dev/null; echo $?`
+if [ ${ECLIPSE_TARGET_AVAILABLE} -ne 1 ]; then
+ echo "WARNING:"
+ echo "This version does not support generating eclipse help"
+ echo "Documentation will not be available in eclipse"
+ exit 1
+fi
+
+for DOC in ${DOCS}; do
+ make DOC=${DOC} eclipse;
+done
+
+sed -e "s/@.*@/${COMMIT_ID}/" < ${DOC_PLUGIN_DIR}/about.html.in >
${DOC_PLUGIN_DIR}/about.html
+
+cd ${TOP}
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFCv3 2/7] plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation
From: Timo Mueller As documentation is licensed under CCA-SA 2.0 UK and the plugin itself is licensed under EPL v1.0 an about file needs to be added to the plugin identifying the third party content. --- plugins/org.yocto.sdk.ide.doc.user/about.html.in | 166 .../org.yocto.sdk.ide.doc.user/build.properties|6 +- 2 files changed, 170 insertions(+), 2 deletions(-) create mode 100644 plugins/org.yocto.sdk.ide.doc.user/about.html.in diff --git a/plugins/org.yocto.sdk.ide.doc.user/about.html.in b/plugins/org.yocto.sdk.ide.doc.user/about.html.in new file mode 100644 index 000..c009f77 --- /dev/null +++ b/plugins/org.yocto.sdk.ide.doc.user/about.html.in @@ -0,0 +1,166 @@ +http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> +http://www.w3.org/1999/xhtml";> + + +About + + + About This Content + + + December, 2012 + + License + + + Copyright (c) 2010 Intel, Inc. and others. + All rights reserved. This program and the accompanying materials + are made available under the terms of the Eclipse Public License v1.0 + which accompanies this distribution, and is available at + http://www.eclipse.org/legal/epl-v10.html";> + http://www.eclipse.org/legal/epl-v10.html + + + + Third Party Content + The Content includes items that have been sourced from the Yocto project + as set out below. If you did not receive this Content directly + from the Linux Foundation, the following is provided for + informational purposes only, and you should look to the + Redistributor's license for terms and conditions of use. + + + Yocto Project Quick Start + + + + This short document lets you get started with the Yocto Project + quickly and start building an image. + + + License: + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode";> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + + + Source Code Repository: + + git://git.yoctoproject.org/yocto-docs + + + Commit: @COMMIT_ID-yocto-project-qs@ + + + + The Yocto Project Application Developer's Guide: + + + + This manual shows you how to setup and use the Application Development + Toolkit (ADT) and stand-alone cross-development toolchains so you can + develop user-space applications. + + + License: + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode";> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + + + Source Code Repository: + + git://git.yoctoproject.org/yocto-docs + + + Commit: @COMMIT_ID-adt-manual@ + + + + The Yocto Project Development Manual: + + + + This manual describes how to use the Yocto Project to develop + embedded Linux images and user-space applications to run on + targeted devices. + + + License: + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode";> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + + + Source Code Repository: + + git://git.yoctoproject.org/yocto-docs + + + Commit: @COMMIT_ID-dev-manual@ + + + + The Yocto Project Reference Manual: + + + + This manual is the complete reference guide to the Poky component. + It also contains a chapter on Board Support Package (BSP) development. + + + License: + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode";> + http://creati
[yocto] [RFCv3 5/7] scripts/generat-doc.sh: Copy generated eclipse help into the user.doc plugin
From: Timo Mueller
After successful generation the eclipse help files and the table of
contents of each manual are copied to the user.doc plugin.
---
scripts/generate_doc.sh |2 ++
1 files changed, 2 insertions(+), 0 deletions(-)
diff --git a/scripts/generate_doc.sh b/scripts/generate_doc.sh
index faab9ef..7d4911f 100755
--- a/scripts/generate_doc.sh
+++ b/scripts/generate_doc.sh
@@ -77,6 +77,8 @@ fi
for DOC in ${DOCS}; do
make DOC=${DOC} eclipse;
+ cp -rf ${DOC}/eclipse/html/* ${DOC_HTML_DIR}
+ cp -f ${DOC}/eclipse/${DOC}-toc.xml ${DOC_HTML_DIR}
done
sed -e "s/@.*@/${COMMIT_ID}/" < ${DOC_PLUGIN_DIR}/about.html.in >
${DOC_PLUGIN_DIR}/about.html
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFCv3 6/7] scripts/build.sh: Add documentation generation to the default build
From: Timo Mueller
When building the plugin the matching documentation is automatically
generated and added to the user.doc plugin prior to the plugin build.
---
scripts/build.sh |7 +++
1 files changed, 7 insertions(+), 0 deletions(-)
diff --git a/scripts/build.sh b/scripts/build.sh
index de81ce3..3597136 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -108,6 +108,13 @@ git checkout origin/${BRANCH} || fail $? "git checkout
origin/${BRANCH}"
git checkout ${TAG} || fail $? "git checkout ${TAG}"
cd ${TOP}
+# generate and add documentation
+if [ "${TAG}" = "HEAD" ]; then
+ ${GIT_DIR}/scripts/generate_doc.sh ${BRANCH} ${GIT_DIR}
+else
+ ${GIT_DIR}/scripts/generate_doc.sh -t ${TAG} ${GIT_DIR}
+fi
+
#build
java -jar ${LAUNCHER} -application org.eclipse.ant.core.antRunner -buildfile
${BUILDFILE} -DbaseLocation=${ECLIPSE_BASE}
-Dbuilder=${GIT_DIR}/features/org.yocto.bc.headless.build
-DbuildDirectory=${BUILD_DIR} -DotherSrcDirectory=${GIT_DIR}
-DbuildId=${RELEASE} || fail $? "normal build"
java -jar ${LAUNCHER} -application org.eclipse.ant.core.antRunner -buildfile
${BUILDFILE} -DbaseLocation=${ECLIPSE_BASE}
-Dbuilder=${GIT_DIR}/features/org.yocto.sdk.headless.build
-DbuildDirectory=${BUILD_DIR} -DotherSrcDirectory=${GIT_DIR}
-DbuildId=${RELEASE} || fail $? "normal build"
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFCv3 7/7] (TEMPORARY): Use origin/timo branch of yocto docs project
From: Timo Mueller
As the eclipse generation is currently not part of the master the generation is
always using the origin/timo branch to generate the eclipse help. This patch is
added for testing purposes only.
DO NOT MERGE THIS PATCH UPSTREAM - ONLY APPLY LOCALLY FOR TESTING
---
scripts/generate_doc.sh |5 +
1 files changed, 5 insertions(+), 0 deletions(-)
diff --git a/scripts/generate_doc.sh b/scripts/generate_doc.sh
index 7d4911f..f5ae55e 100755
--- a/scripts/generate_doc.sh
+++ b/scripts/generate_doc.sh
@@ -48,6 +48,11 @@ else
fi
PLUGIN_FOLDER=$2
+#
+# TODO remove this section if eclipse generation is merged into master
+REFERENCE=origin/timo
+#
+
TOP=`pwd`
DOC_DIR=${PLUGIN_FOLDER}/docs
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 2/3] scripts/build.sh: Added help option to the cmdline
From: Timo Mueller
Calling the build script with the -h option will now show the usage.
The cmdline parsing can be extended to add new options in the future.
---
scripts/build.sh | 18 ++
1 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/scripts/build.sh b/scripts/build.sh
index cbb7375..693dcf7 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -3,12 +3,13 @@
help ()
{
echo "Build the Yocto Eclipse plugins"
- echo "Usage: $0 ";
+ echo "Usage: $0 [OPTIONS] BRANCH_NAME RELEASE_NAME [TAG_NAME]";
echo ""
echo "Options:"
- echo " - git branch name to build upon"
- echo " - release name in the final output name"
- echo "[tag name] - git tag name to build upon. defaults to master if not set"
+ echo "-h - display this help and exit"
+ echo "BRANCH_NAME - git branch name to build upon"
+ echo "RELEAES_NAME - release name in the final output name"
+ echo "TAG_NAME - git tag name to build upon. defaults to HEAD if not set"
echo ""
echo "Example: $0 master r0 M1.1_rc1";
exit 1;
@@ -66,6 +67,15 @@ check_env ()
}
USE_LOCAL_GIT_REPO=0
+while getopts ":h" opt; do
+ case $opt in
+ h)
+ help
+ ;;
+ esac
+done
+shift $(($OPTIND - 1))
+
if [ $# -ne 2 ] && [ $# -ne 3 ]; then
help
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 3/3] script/build.sh: Added option to enable building from local repository.
From: Timo Mueller If the script is called with the -l option the local git repository is used instead of the upstream repository. --- scripts/build.sh |6 +- 1 files changed, 5 insertions(+), 1 deletions(-) diff --git a/scripts/build.sh b/scripts/build.sh index 693dcf7..54081d5 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -7,6 +7,7 @@ help () echo "" echo "Options:" echo "-h - display this help and exit" + echo "-l - use local git repository" echo "BRANCH_NAME - git branch name to build upon" echo "RELEAES_NAME - release name in the final output name" echo "TAG_NAME - git tag name to build upon. defaults to HEAD if not set" @@ -67,11 +68,14 @@ check_env () } USE_LOCAL_GIT_REPO=0 -while getopts ":h" opt; do +while getopts ":lh" opt; do case $opt in h) help ;; + l) + USE_LOCAL_GIT_REPO=1 + ;; esac done shift $(($OPTIND - 1)) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 0/3][eclipse-poky] Add option to allow building from local repo
From: Timo Mueller Hi, I've rebased the patch series. It should now apply to the current master. Best regards, Timo >From the original cover letter: if you build eclipse-poky with the provided build script it will always use the upstream version of the IDE. During development I wanted to use my local repository to make sure that my changes don't break the build system. Therefor I added an option to the build script to allow building from the local eclipse-poky git repository. Timo Mueller (3): scripts/build.sh: Added function to use the local repository for building scripts/build.sh: Added help option to the cmdline script/build.sh: Added option to enable building from local repository. scripts/build.sh | 30 ++ 1 files changed, 26 insertions(+), 4 deletions(-) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv2 1/3] scripts/build.sh: Added function to use the local repository for building
From: Timo Mueller
If USE_LOCAL_GIT_REPO is set to 1 the build scripts uses the local
repository of the eclipse poky project for building instead of the
upstream project. The local repository is derived from the location
for the build script.
---
scripts/build.sh |8
1 files changed, 8 insertions(+), 0 deletions(-)
diff --git a/scripts/build.sh b/scripts/build.sh
index de81ce3..cbb7375 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -65,6 +65,8 @@ check_env ()
fi
}
+USE_LOCAL_GIT_REPO=0
+
if [ $# -ne 2 ] && [ $# -ne 3 ]; then
help
fi
@@ -97,6 +99,12 @@ mkdir ${BUILD_DIR} || fail $? "Create temporary build
directory ${BUILD_DIR}"
#git clone
GIT_URL=git://git.pokylinux.org/eclipse-poky.git
+if [ $USE_LOCAL_GIT_REPO -eq 1 ]; then
+ SCRIPT_DIR=`dirname $0`
+ GIT_DIR=`readlink -f ${SCRIPTDIR}\..`
+ GIT_URL="file://${GIT_DIR}"
+fi
+
GIT_DIR=${BUILD_SRC}
#mkdir ${GIT_DIR}
#cp -r features/ ${GIT_DIR}
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv3 1/3] scripts/build.sh: Added function to use the local repository for building
From: Timo Mueller
If USE_LOCAL_GIT_REPO is set to 1 the build scripts uses the local
repository of the eclipse poky project for building instead of the
upstream project. The local repository is derived from the location
for the build script.
Signed-off-by: Timo Mueller
---
scripts/build.sh |8
1 files changed, 8 insertions(+), 0 deletions(-)
diff --git a/scripts/build.sh b/scripts/build.sh
index de81ce3..cbb7375 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -65,6 +65,8 @@ check_env ()
fi
}
+USE_LOCAL_GIT_REPO=0
+
if [ $# -ne 2 ] && [ $# -ne 3 ]; then
help
fi
@@ -97,6 +99,12 @@ mkdir ${BUILD_DIR} || fail $? "Create temporary build
directory ${BUILD_DIR}"
#git clone
GIT_URL=git://git.pokylinux.org/eclipse-poky.git
+if [ $USE_LOCAL_GIT_REPO -eq 1 ]; then
+ SCRIPT_DIR=`dirname $0`
+ GIT_DIR=`readlink -f ${SCRIPTDIR}\..`
+ GIT_URL="file://${GIT_DIR}"
+fi
+
GIT_DIR=${BUILD_SRC}
#mkdir ${GIT_DIR}
#cp -r features/ ${GIT_DIR}
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv3 2/3] scripts/build.sh: Added help option to the cmdline
From: Timo Mueller
Calling the build script with the -h option will now show the usage.
The cmdline parsing can be extended to add new options in the future.
Signed-off-by: Timo Mueller
---
scripts/build.sh | 18 ++
1 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/scripts/build.sh b/scripts/build.sh
index cbb7375..693dcf7 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -3,12 +3,13 @@
help ()
{
echo "Build the Yocto Eclipse plugins"
- echo "Usage: $0 ";
+ echo "Usage: $0 [OPTIONS] BRANCH_NAME RELEASE_NAME [TAG_NAME]";
echo ""
echo "Options:"
- echo " - git branch name to build upon"
- echo " - release name in the final output name"
- echo "[tag name] - git tag name to build upon. defaults to master if not set"
+ echo "-h - display this help and exit"
+ echo "BRANCH_NAME - git branch name to build upon"
+ echo "RELEAES_NAME - release name in the final output name"
+ echo "TAG_NAME - git tag name to build upon. defaults to HEAD if not set"
echo ""
echo "Example: $0 master r0 M1.1_rc1";
exit 1;
@@ -66,6 +67,15 @@ check_env ()
}
USE_LOCAL_GIT_REPO=0
+while getopts ":h" opt; do
+ case $opt in
+ h)
+ help
+ ;;
+ esac
+done
+shift $(($OPTIND - 1))
+
if [ $# -ne 2 ] && [ $# -ne 3 ]; then
help
--
1.7.7.6
___
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv3 0/3][eclipse-poky] Add option to allow building from local repo
From: Timo Mueller Hi, as Paul requested I've signed-off the patches. Other than that it's still the rebased patch series from PATCHv2. Best regards, Timo >From the original cover letter: if you build eclipse-poky with the provided build script it will always use the upstream version of the IDE. During development I wanted to use my local repository to make sure that my changes don't break the build system. Therefor I added an option to the build script to allow building from the local eclipse-poky git repository. Timo Mueller (3): scripts/build.sh: Added function to use the local repository for building scripts/build.sh: Added help option to the cmdline script/build.sh: Added option to enable building from local repository. scripts/build.sh | 30 ++ 1 files changed, 26 insertions(+), 4 deletions(-) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCHv3 3/3] script/build.sh: Added option to enable building from local repository.
From: Timo Mueller If the script is called with the -l option the local git repository is used instead of the upstream repository. Signed-off-by: Timo Mueller --- scripts/build.sh |6 +- 1 files changed, 5 insertions(+), 1 deletions(-) diff --git a/scripts/build.sh b/scripts/build.sh index 693dcf7..54081d5 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -7,6 +7,7 @@ help () echo "" echo "Options:" echo "-h - display this help and exit" + echo "-l - use local git repository" echo "BRANCH_NAME - git branch name to build upon" echo "RELEAES_NAME - release name in the final output name" echo "TAG_NAME - git tag name to build upon. defaults to HEAD if not set" @@ -67,11 +68,14 @@ check_env () } USE_LOCAL_GIT_REPO=0 -while getopts ":h" opt; do +while getopts ":lh" opt; do case $opt in h) help ;; + l) + USE_LOCAL_GIT_REPO=1 + ;; esac done shift $(($OPTIND - 1)) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 1/8] plugins/sdk.doc.user: Added plugin for the yocto project documentation
From: Timo Mueller This currently empty plugin will in the future contain the documentation of the yocto project converted to the eclipse help format. --- plugins/org.yocto.sdk.doc.user/.classpath |6 plugins/org.yocto.sdk.doc.user/.project| 28 .../.settings/org.eclipse.jdt.core.prefs |8 + .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF|7 + .../OSGI-INF/l10n/bundle.properties|3 ++ plugins/org.yocto.sdk.doc.user/build.properties|4 +++ plugins/org.yocto.sdk.doc.user/plugin.xml |4 +++ 7 files changed, 60 insertions(+), 0 deletions(-) create mode 100644 plugins/org.yocto.sdk.doc.user/.classpath create mode 100644 plugins/org.yocto.sdk.doc.user/.project create mode 100644 plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs create mode 100644 plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.sdk.doc.user/build.properties create mode 100644 plugins/org.yocto.sdk.doc.user/plugin.xml diff --git a/plugins/org.yocto.sdk.doc.user/.classpath b/plugins/org.yocto.sdk.doc.user/.classpath new file mode 100644 index 000..bc74aab --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/.classpath @@ -0,0 +1,6 @@ + + + + + + diff --git a/plugins/org.yocto.sdk.doc.user/.project b/plugins/org.yocto.sdk.doc.user/.project new file mode 100644 index 000..d361cd4 --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/.project @@ -0,0 +1,28 @@ + + + org.yocto.sdk.doc.user + + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.pde.ManifestBuilder + + + + + org.eclipse.pde.SchemaBuilder + + + + + + org.eclipse.pde.PluginNature + org.eclipse.jdt.core.javanature + + diff --git a/plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs b/plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 000..f90fa9c --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,8 @@ +#Fri Mar 04 13:59:33 CET 2011 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.source=1.6 diff --git a/plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF b/plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF new file mode 100644 index 000..6bece6b --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF @@ -0,0 +1,7 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %plugin.name +Bundle-SymbolicName: org.yocto.sdk.doc.user;singleton:=true +Bundle-Version: 1.2.0.qualifier +Bundle-Vendor: %plugin.provider +Bundle-RequiredExecutionEnvironment: JavaSE-1.6 diff --git a/plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties b/plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties new file mode 100644 index 000..61e70de --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties @@ -0,0 +1,3 @@ +#Properties file for org.yocto.sdk.doc.user +Bundle-Vendor = yoctoproject.org +Bundle-Name = Yocto Project Documentation diff --git a/plugins/org.yocto.sdk.doc.user/build.properties b/plugins/org.yocto.sdk.doc.user/build.properties new file mode 100644 index 000..31e0140 --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/build.properties @@ -0,0 +1,4 @@ +bin.includes = plugin.xml,\ + .,\ + META-INF/,\ + OSGI-INF/ diff --git a/plugins/org.yocto.sdk.doc.user/plugin.xml b/plugins/org.yocto.sdk.doc.user/plugin.xml new file mode 100644 index 000..f422d55 --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/plugin.xml @@ -0,0 +1,4 @@ + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 2/8] plugins/sdk.doc.user: Added empty table of contents
From: Timo Mueller This is the preparation needed for adding documentation from the yocto project later on. --- .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF|1 + plugins/org.yocto.sdk.doc.user/build.properties|2 ++ plugins/org.yocto.sdk.doc.user/plugin.xml |7 +++ plugins/org.yocto.sdk.doc.user/toc.xml |3 +++ 4 files changed, 13 insertions(+), 0 deletions(-) create mode 100644 plugins/org.yocto.sdk.doc.user/toc.xml diff --git a/plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF b/plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF index 6bece6b..b28168f 100644 --- a/plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF +++ b/plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF @@ -5,3 +5,4 @@ Bundle-SymbolicName: org.yocto.sdk.doc.user;singleton:=true Bundle-Version: 1.2.0.qualifier Bundle-Vendor: %plugin.provider Bundle-RequiredExecutionEnvironment: JavaSE-1.6 +Require-Bundle: org.eclipse.help diff --git a/plugins/org.yocto.sdk.doc.user/build.properties b/plugins/org.yocto.sdk.doc.user/build.properties index 31e0140..cc18fce 100644 --- a/plugins/org.yocto.sdk.doc.user/build.properties +++ b/plugins/org.yocto.sdk.doc.user/build.properties @@ -1,4 +1,6 @@ bin.includes = plugin.xml,\ .,\ META-INF/,\ + toc.xml,\ OSGI-INF/ +src.includes = toc.xml diff --git a/plugins/org.yocto.sdk.doc.user/plugin.xml b/plugins/org.yocto.sdk.doc.user/plugin.xml index f422d55..367962c 100644 --- a/plugins/org.yocto.sdk.doc.user/plugin.xml +++ b/plugins/org.yocto.sdk.doc.user/plugin.xml @@ -1,4 +1,11 @@ + + + + diff --git a/plugins/org.yocto.sdk.doc.user/toc.xml b/plugins/org.yocto.sdk.doc.user/toc.xml new file mode 100644 index 000..4d30d0d --- /dev/null +++ b/plugins/org.yocto.sdk.doc.user/toc.xml @@ -0,0 +1,3 @@ + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 0/8] Integrate yocto documentation into eclipse
From: Timo Mueller Hi, the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide. In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it? Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured? Cheers, Timo Timo Mueller (8): plugins/sdk.doc.user: Added plugin for the yocto project documentation plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual features/org.yocto.sdk.doc/.project| 17 + features/org.yocto.sdk.doc/build.properties|5 + features/org.yocto.sdk.doc/feature.properties | 208 ++ features/org.yocto.sdk.doc/feature.xml | 40 ++ features/org.yocto.sdk.doc/license.html| 237 +++ .../sourceTemplateFeature/feature.properties | 208 ++ .../sourceTemplateFeature/license.html | 237 +++ features/org.yocto.sdk.site/category.xml |6 + features/org.yocto.sdk.site/site.xml |3 + features/org.yocto.sdk/feature.xml |5 + plugins/org.yocto.sdk.doc.user/.classpath |6 + plugins/org.yocto.sdk.doc.user/.project| 28 + .../.settings/org.eclipse.jdt.core.prefs |8 + .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF|8 + .../OSGI-INF/l10n/bundle.properties|3 + plugins/org.yocto.sdk.doc.user/about.html | 82 +++ plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml | 61 ++ plugins/org.yocto.sdk.doc.user/build.properties| 14 + .../html/adt-manual/ch01.html | 90 +++ .../html/adt-manual/ch01s02.html | 166 + .../html/adt-manual/ch02.html | 450 + .../html/adt-manual/ch02s02.html | 56 ++ .../html/adt-manual/ch02s03.html | 182 ++ .../html/adt-manual/ch03.html | 97 +++ .../html/adt-manual/ch03s02.html | 78 +++ .../html/adt-manual/ch04.html | 675 .../html/adt-manual/ch04s02.html | 94 +++ .../html/adt-manual/ch04s03.html | 77 +++ .../html/adt-manual/ch04s04.html | 37 ++ .../html/adt-manual/ch04s05.html | 65 ++ .../html/adt-manual/ch04s06.html | 100 +++ .../html/adt-manual/ch04s07.html | 161 + .../html/adt-manual/ch04s08.html | 184 ++ .../html/adt-manual/ch05.html | 112 .../html/adt-manual/ch05s02.html | 41 ++ .../html/adt-manual/index.html | 260 plugins/org.yocto.sdk.doc.user/html/book.css |1 + .../yocto-project-qs/figures/building-an-image.png | Bin 0 -> 14891 bytes .../figures/using-a-pre-built-image.png| Bin 0 -> 12733 bytes .../yocto-project-qs/figures/yocto-environment.png | Bin 0 -> 73095 bytes .../figures/yocto-project-transp.png | Bin 0 -> 8626 bytes .../html/yocto-project-qs/index.html | 542 plugins/org.yocto.sdk.doc.user/plugin.xml | 19 + plugins/org.yocto.sdk.doc.user/toc.xml |9 + .../yocto-project-qs-toc.xml | 32 + 45 files changed, 4704 insertions(+), 0 deletions(-) create mode 100644 features/org.yocto.sdk.doc/.project create mode 100644 features/org.yocto.sdk.doc/build.properties create mode 100644 features/org.yocto.sdk.doc/feature.properties create mode 100644 features/org.yocto.sdk.doc/feature.xml create mode 100644 features/org.yocto.sdk.doc/license.html create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/license.html create mode 100644 plugins/org.yocto.sdk.doc.user/.classpath create mode 100644 plugins/org.yocto.sdk.doc.user/.project
[yocto] [RFC 4/8] feature/sdk.doc: Added org.yocto.sdk.doc.user plugin
From: Timo Mueller The added plugin will contain the official documentation of the yocto project. --- features/org.yocto.sdk.doc/feature.xml |8 1 files changed, 8 insertions(+), 0 deletions(-) diff --git a/features/org.yocto.sdk.doc/feature.xml b/features/org.yocto.sdk.doc/feature.xml index f4b7605..1300f55 100644 --- a/features/org.yocto.sdk.doc/feature.xml +++ b/features/org.yocto.sdk.doc/feature.xml @@ -29,4 +29,12 @@ + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 3/8] feature/sdk.doc: Added feature containing yocto documentation plugins
From: Timo Mueller
The project documentation of yocto is licensed under the Create
Commons Attribution Share Alike 2.0 (CCA-SA). Because the plugins
containing this documentation cannot be licensed under the Eclipse
Public License 1.0, as it is not compatible to the CCA-SA, this
feature will contain all plugins licensed by the CCA-SA.
The idea is to cleanly separate content licensed by the different
licenses.
---
features/org.yocto.sdk.doc/.project| 17 ++
features/org.yocto.sdk.doc/build.properties|5 +
features/org.yocto.sdk.doc/feature.properties | 208 +
features/org.yocto.sdk.doc/feature.xml | 32 +++
features/org.yocto.sdk.doc/license.html| 237
.../sourceTemplateFeature/feature.properties | 208 +
.../sourceTemplateFeature/license.html | 237
7 files changed, 944 insertions(+), 0 deletions(-)
create mode 100644 features/org.yocto.sdk.doc/.project
create mode 100644 features/org.yocto.sdk.doc/build.properties
create mode 100644 features/org.yocto.sdk.doc/feature.properties
create mode 100644 features/org.yocto.sdk.doc/feature.xml
create mode 100644 features/org.yocto.sdk.doc/license.html
create mode 100644
features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties
create mode 100644
features/org.yocto.sdk.doc/sourceTemplateFeature/license.html
diff --git a/features/org.yocto.sdk.doc/.project
b/features/org.yocto.sdk.doc/.project
new file mode 100644
index 000..7418615
--- /dev/null
+++ b/features/org.yocto.sdk.doc/.project
@@ -0,0 +1,17 @@
+
+
+ org.yocto.sdk.doc
+
+
+
+
+
+ org.eclipse.pde.FeatureBuilder
+
+
+
+
+
+ org.eclipse.pde.FeatureNature
+
+
diff --git a/features/org.yocto.sdk.doc/build.properties
b/features/org.yocto.sdk.doc/build.properties
new file mode 100644
index 000..b0439e2
--- /dev/null
+++ b/features/org.yocto.sdk.doc/build.properties
@@ -0,0 +1,5 @@
+bin.includes = feature.xml,\
+ feature.properties,\
+ license.html
+
+generate.feat...@org.yocto.sdk.doc.source=org.yocto.sdk.doc
diff --git a/features/org.yocto.sdk.doc/feature.properties
b/features/org.yocto.sdk.doc/feature.properties
new file mode 100644
index 000..c15adce
--- /dev/null
+++ b/features/org.yocto.sdk.doc/feature.properties
@@ -0,0 +1,208 @@
+featureName=Yocto Documentation Plugin for Eclipse
+providerName=yoctoproject.org
+
+updateSiteName=Yocto Update Site
+
+description=\
+Eclipse plug-ins containing the documentation for developing embedded \
+applications for Yocto based embedded Linux.
+
+copyright=\
+Copyright (c) 2010 Intel, Inc. and others. \
+All rights reserved. This program and the accompanying materials \
+are made available under the terms of the Creative Commons Attribution-Share \
+Alike 2.0 UK: England & Wales which accompanies this distribution, \
+and is available at \
+http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode
+
+licenseURL=license.html
+license=\
+Creative Commons Attribution-Share Alike 2.0 UK: England & Wales\n\
+\n\
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS \
+CREATIVE COMMONS PUBLIC LICENCE ("CCPL" OR "LICENCE"). THE WORK IS \
+PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE \
+WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENCE OR COPYRIGHT LAW IS \
+PROHIBITED. BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU \
+ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENCE. THE \
+LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR \
+ACCEPTANCE OF SUCH TERMS AND CONDITIONS. \
+\n\
+This Creative Commons England and Wales Public Licence enables You \
+(all capitalised terms defined below) to view, edit, modify, translate \
+and distribute Works worldwide, under the terms of this licence, \
+provided that You credit the Original Author. \
+\n\
+'The Licensor' [one or more legally recognised persons or entities \
+offering the Work under the terms and conditions of this Licence] \
+\n \
+and \
+\n \
+'You' \
+\n \
+agree as follows: \
+\n \
+1. Definitions \
+\n \
+"Attribution" means acknowledging all the parties who have contributed \
+to and have rights in the Work or Collective Work under this Licence. \
+"Collective Work" means the Work in its entirety in unmodified form \
+along with a number of other separate and independent works, assembled \
+into a collective whole. "Derivative Work" means any work created by \
+the editing, modification, adaptation or translation of the Work in \
+any media (however a work that constitutes a Collective Work will not \
+be considered a Derivative Work for the purpose of this Licence). For \
+the avoidance of doubt, where the Work is a musical composition or \
+sound recording, the synchroni
[yocto] [RFC 6/8] feature/sdk: Added org.yocto.sdk.doc feature.
From: Timo Mueller The feature is added to the yocto main feature so it will be part of the build. Also when installing the documentation feature will also be installed. To be able to install the documentation feature is has to be available via an eclipse update site. It is currently not part of the official yocto update site. Therefor the feature has to be installed manually until it is part of the yocto update site. --- features/org.yocto.sdk/feature.xml |5 + 1 files changed, 5 insertions(+), 0 deletions(-) diff --git a/features/org.yocto.sdk/feature.xml b/features/org.yocto.sdk/feature.xml index 0fce8db..7ee6575 100644 --- a/features/org.yocto.sdk/feature.xml +++ b/features/org.yocto.sdk/feature.xml @@ -8,6 +8,7 @@ Contributors: Intel - initial API and implementation +BMW Car IT GmbH - added yocto documentation feature --> + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 7/8] features/sdk.site: Added eclipse help feature to update site
From: Timo Mueller Using the update site the user is able to install the documentation feature. As it is required by yocto's main feature it will be automatically installed during the main features installation. --- features/org.yocto.sdk.site/category.xml |6 ++ features/org.yocto.sdk.site/site.xml |3 +++ 2 files changed, 9 insertions(+), 0 deletions(-) diff --git a/features/org.yocto.sdk.site/category.xml b/features/org.yocto.sdk.site/category.xml index 9fb50b2..e21f3fb 100644 --- a/features/org.yocto.sdk.site/category.xml +++ b/features/org.yocto.sdk.site/category.xml @@ -6,5 +6,11 @@ + + + + + + diff --git a/features/org.yocto.sdk.site/site.xml b/features/org.yocto.sdk.site/site.xml index 59ebbd5..e33e91a 100644 --- a/features/org.yocto.sdk.site/site.xml +++ b/features/org.yocto.sdk.site/site.xml @@ -6,5 +6,8 @@ + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 1/6] documentation/adt-manual: Moved stylesheet parameters to customization file
From: Timo Mueller Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Furthermore supporting new output formats can now be achieved by creating a new customization file containing its corresponding parameters. Parameters that are used across different stylesheets with different values will then be separated through different customization files. Global parameters can still be set through the XSLTOPTS variable since this precedes the parameters in the customization file. --- documentation/Makefile |7 +-- .../adt-manual/adt-manual-customization.xsl|7 +-- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index ee7089a..380193d 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -213,12 +213,7 @@ endif ifeq ($(DOC),adt-manual) -XSLTOPTS = --stringparam html.stylesheet adt-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 = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf diff --git a/documentation/adt-manual/adt-manual-customization.xsl b/documentation/adt-manual/adt-manual-customization.xsl index 8eb6905..373bdb7 100644 --- a/documentation/adt-manual/adt-manual-customization.xsl +++ b/documentation/adt-manual/adt-manual-customization.xsl @@ -3,6 +3,9 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> - - + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 0/6][yocto-docs] Add eclipse help generation to build system.
From: Timo Mueller Hi, before my vacation I've submitted a patch to the eclipse-poky project integrating the documentation into the eclipse IDE. To enable the integration into eclipse I've manually generated eclipse help from the documentation using the eclipse stylesheet provided by docbook. I've added the target 'eclipse' to the documentation's build system to automate the process of eclipse help generation. This can help to facilitate the process of keeping the integrated documentation in sync with the yocto documentation. In this first RFC I've only integrated the adt-manual as a PoC, because I'm also proposing some changes to the existing html generation. These changes add a separation of the options used for the different output formats. They also help to keep the Makefile clean and concise. Cheers, Timo Timo Mueller (6): documentation/adt-manual: Moved stylesheet parameters to customization file documentation/adt-manual/adt-manual-eclipse-customization.xsl: Added stylesheet for eclipse help documentation/Makefile: Added eclipse target for generating eclipse help documentation/template/titlepage.templates.xml: Remove title from pdf template documentation/adt-manual/adt-manual.xml: Added title to bookinfo documentation/Makefile: Added eclipse target to adt-manual documentation documentation/Makefile | 36 ++- .../adt-manual/adt-manual-customization.xsl|7 +++- .../adt-manual-eclipse-customization.xsl | 22 documentation/adt-manual/adt-manual.xml|5 ++- documentation/template/titlepage.templates.xml | 13 --- 5 files changed, 57 insertions(+), 26 deletions(-) create mode 100644 documentation/adt-manual/adt-manual-eclipse-customization.xsl -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 2/6] documentation/adt-manual/adt-manual-eclipse-customization.xsl: Added stylesheet for eclipse help
From: Timo Mueller 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). --- .../adt-manual-eclipse-customization.xsl | 22 1 files changed, 22 insertions(+), 0 deletions(-) create mode 100644 documentation/adt-manual/adt-manual-eclipse-customization.xsl diff --git a/documentation/adt-manual/adt-manual-eclipse-customization.xsl b/documentation/adt-manual/adt-manual-eclipse-customization.xsl new file mode 100644 index 000..7844738 --- /dev/null +++ b/documentation/adt-manual/adt-manual-eclipse-customization.xsl @@ -0,0 +1,22 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 3/6] documentation/Makefile: Added eclipse target for generating eclipse help
From: Timo Mueller This target will generate eclipse help for the adt-manual using the adt-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 | 20 1 files changed, 20 insertions(+), 0 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 380193d..87e1fde 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -284,6 +284,26 @@ else endif +eclipse: BASE_DIR = html/$(DOC)/ + +eclipse: +ifneq ($(DOC),adt-manual) + @echo " " + @echo "ERROR: You can only create eclipse documentation of the" + @echo " Yocto Project Application Development Toolkit (ADT)" + @echo " User's Guide" + @echo " " +else + 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); \ + cd .. +endif + tarball: html @echo " " @echo " Creating Tarball of document files" -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 4/6] documentation/template/titlepage.templates.xml: Remove title from pdf template
From: Timo Mueller The title of a pdf document is part of the image used on the title page. Thus the title defined (e.g. bookinfo.title) in a document should never be used when creating title pages for pdf documents. As other output formats may use the title information to create metadata the title has been removed from the template. --- documentation/template/titlepage.templates.xml | 13 - 1 files changed, 0 insertions(+), 13 deletions(-) diff --git a/documentation/template/titlepage.templates.xml b/documentation/template/titlepage.templates.xml index ff640fa..f53f147 100644 --- a/documentation/template/titlepage.templates.xml +++ b/documentation/template/titlepage.templates.xml @@ -140,14 +140,6 @@ - - -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 6/6] documentation/Makefile: Added eclipse target to adt-manual documentation
From: Timo Mueller Eclipse help documents are now created when calling the 'make all' target on the adt-manual. 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, 5 insertions(+), 4 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 87e1fde..0537c22 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -214,9 +214,10 @@ endif ifeq ($(DOC),adt-manual) XSLTOPTS = --xinclude -ALLPREQ = html pdf tarball -TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png -MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf +ALLPREQ = html pdf eclipse tarball +TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png \ + eclipse +MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse FIGURES = figures STYLESHEET = $(DOC)/*.css endif @@ -329,4 +330,4 @@ publish: fi clean: - rm -f $(MANUALS) + rm -rf $(MANUALS) -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [RFC 5/6] documentation/adt-manual/adt-manual.xml: Added title to bookinfo
From: Timo Mueller The title of the document used to create metadata for output formats such as eclipse help. --- documentation/adt-manual/adt-manual.xml |5 - 1 files changed, 4 insertions(+), 1 deletions(-) diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml index e34dc1c..614a38e 100644 --- a/documentation/adt-manual/adt-manual.xml +++ b/documentation/adt-manual/adt-manual.xml @@ -16,7 +16,10 @@ - + +The Yocto Project Application Development Toolkit (ADT) +User's Guide. + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 03/25] documentation/dev-manual/dev-manual-eclipse-customization.xsl: new file
From: Timo Mueller 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 diff --git a/documentation/dev-manual/dev-manual-eclipse-customization.xsl b/documentation/dev-manual/dev-manual-eclipse-customization.xsl new file mode 100644 index 000..3463512 --- /dev/null +++ b/documentation/dev-manual/dev-manual-eclipse-customization.xsl @@ -0,0 +1,21 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 04/25] documentation/Makefile: Support for making Eclipse HTML dev manual
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 1e8b558..812a6d7 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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) && \ -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 01/25] documentation/Makefile: Stop eclipse target workflow if generation fails.
From: Timo Mueller --- documentation/Makefile |8 1 files changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/Makefile b/documentation/Makefile index 0537c22..005d670 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 02/25] documentation: Move dev-manual global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 005d670..1e8b558 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 diff --git a/documentation/dev-manual/dev-manual-customization.xsl b/documentation/dev-manual/dev-manual-customization.xsl index 8eb6905..8969605 100644 --- a/documentation/dev-manual/dev-manual-customization.xsl +++ b/documentation/dev-manual/dev-manual-customization.xsl @@ -3,6 +3,8 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> - - + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 00/25][yocto-docs] Add eclipse help generation for remaining documents
From: Timo Mueller 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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 08/25] documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new file
From: Timo Mueller 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 diff --git a/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl new file mode 100644 index 000..d85d901 --- /dev/null +++ b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl @@ -0,0 +1,21 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 05/25] documentation/dev-manual/dev-manual.xml: Added Title tag
From: Timo Mueller 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(-) diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml index 0cbd85f..9617fa0 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml @@ -16,7 +16,9 @@ - + + The Yocto Project Development Manual + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 06/25] documentation/Makefile: logic to make all for adt manual and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 812a6d7..45ba6b6 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 09/25] documentation/Makefile: Support for making Eclipse HTML bsp guide
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index e601fef..815ab53 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 07/25] documentation: Move bsp-guide global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 45ba6b6..e601fef 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 diff --git a/documentation/bsp-guide/bsp-guide-customization.xsl b/documentation/bsp-guide/bsp-guide-customization.xsl index 362ebed..5560289 100644 --- a/documentation/bsp-guide/bsp-guide-customization.xsl +++ b/documentation/bsp-guide/bsp-guide-customization.xsl @@ -3,4 +3,8 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 11/25] documentation/Makefile: logic to make all for bsp guide and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 815ab53..02206b5 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 10/25] documentation/bsp-guide/bsp-guide.xml: Added Title tag
From: Timo Mueller 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(-) diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 3b7ab6a..c3629bd 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -16,7 +16,9 @@ - + + The Yocto Project Board Support Package Developer's Guide + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 12/25] documentation: Move kernel-manual global parameters to customization file
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 02206b5..9b816a1 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 diff --git a/documentation/kernel-manual/kernel-manual-customization.xsl b/documentation/kernel-manual/kernel-manual-customization.xsl index 8eb6905..6f46df2 100644 --- a/documentation/kernel-manual/kernel-manual-customization.xsl +++ b/documentation/kernel-manual/kernel-manual-customization.xsl @@ -3,6 +3,9 @@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"; /> - - + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 13/25] documentation/kernel-manual/kernel-manual-eclipse-customization.xsl: new file
From: Timo Mueller 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 diff --git a/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl b/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl new file mode 100644 index 000..2980869 --- /dev/null +++ b/documentation/kernel-manual/kernel-manual-eclipse-customization.xsl @@ -0,0 +1,21 @@ + +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"> + + http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl"; /> + + + + + + + + + + + + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 14/25] documentation/Makefile: Support for making Eclipse HTML kernel manual
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index 9b816a1..f64e21c 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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) && \ -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 15/25] documentation/kernel-manual/kernel-manual.xml: Added Title tag
From: Timo Mueller 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(-) diff --git a/documentation/kernel-manual/kernel-manual.xml b/documentation/kernel-manual/kernel-manual.xml index 174663a..0d683ef 100644 --- a/documentation/kernel-manual/kernel-manual.xml +++ b/documentation/kernel-manual/kernel-manual.xml @@ -16,7 +16,9 @@ - + + The Yocto Project Kernel Architecture and Use Manual + -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 16/25] documentation/Makefile: logic to make all for kernel-manual and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index f64e21c..23b4d9f 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
[yocto] [PATCH 21/25] documentation/Makefile: logic to make all for poky-ref-manual and cleanup
From: Timo Mueller 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(-) diff --git a/documentation/Makefile b/documentation/Makefile index ba26214..33ebd3c 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -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 -- 1.7.7.6 ___ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto
