Integrate yocto documentation into eclipse
v5 cover Integrate yocto documentation into eclipse
From: Timo Mueller <[email protected]>
v5: Incorporates changes resulting from the renaming of documentation and adds the profile-manual. This patch set requires changes proposed in "[PATCH][yocto-docs] Update eclipse help generation to support all documents"
From RFC v4:
Hi,
the last proposal integrated the yocto documentation into the existing doc plugin of the yocto ADT feature. As Jessica pointed out is does not make sense to bundle all parts of the yocto documentation with the ADT feature. As some parts of the documentation could also be helpful with the BitBake Commander feature, we agreed to encapsulate the yocto documentation into its own feature.
01..02: Fixing typos in build and site scripts
03..12: Adding the yocto documentation as a new feature 13: Temporary patch to use timo branch of docs project - DO NOT MERGE
From the last propsal:
<snip>
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.
</snip>
<snip>
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. </snip>
<snip>
I have intergrated this
documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents).
</snip>
Best regards
Timo
Timo Mueller (12):
features/sdk.site: Fixed typo in category name
Fixed typo in version variable name plugins/sdk.ide.doc.user: Add empty eclipse help plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto
documentation
features/org.yocto.doc: Add new feature containing yocto project
documentation
features/doc.headless.build: Added headless build for yocto.doc
feature
features/sdk.site: Added yocto.doc feature to update site scripts/build.sh: Added yocto.doc feature to build 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/generate-doc.sh: Copy generated eclipse help into the
user.doc plugin
scripts/build.sh: Add documentation generation to the default build
.../org.yocto.bc.headless.build/customTargets.xml | 4 +- features/org.yocto.doc.headless.build/.project | 11 + .../org.yocto.doc.headless.build/build.properties | 262 +++++++++++++++++++++ .../org.yocto.doc.headless.build/customTargets.xml | 212 +++++++++++++++++ features/org.yocto.doc/.project | 17 ++ features/org.yocto.doc/build.properties | 3 + features/org.yocto.doc/feature.properties | 163 +++++++++++++ features/org.yocto.doc/feature.xml | 35 +++ features/org.yocto.doc/license.html | 107 +++++++++ .../org.yocto.sdk.headless.build/customTargets.xml | 4 +- features/org.yocto.sdk.site/category.xml | 10 +- features/org.yocto.sdk.site/site.xml | 10 +- plugins/org.yocto.doc.user/.classpath | 6 + plugins/org.yocto.doc.user/.project | 28 +++ plugins/org.yocto.doc.user/META-INF/MANIFEST.MF | 8 + .../OSGI-INF/l10n/bundle.properties | 3 + plugins/org.yocto.doc.user/about.html.in | 189 +++++++++++++++ plugins/org.yocto.doc.user/build.properties | 9 + plugins/org.yocto.doc.user/html/book.css | 1 + plugins/org.yocto.doc.user/plugin.xml | 39 +++ plugins/org.yocto.doc.user/toc.xml | 24 ++ scripts/build.sh | 18 +- scripts/generate-doc.sh | 87 +++++++ 23 files changed, 1238 insertions(+), 12 deletions(-) create mode 100644 features/org.yocto.doc.headless.build/.project create mode 100644 features/org.yocto.doc.headless.build/build.properties create mode 100644 features/org.yocto.doc.headless.build/customTargets.xml create mode 100644 features/org.yocto.doc/.project create mode 100644 features/org.yocto.doc/build.properties create mode 100644 features/org.yocto.doc/feature.properties create mode 100644 features/org.yocto.doc/feature.xml create mode 100644 features/org.yocto.doc/license.html create mode 100644 plugins/org.yocto.doc.user/.classpath create mode 100644 plugins/org.yocto.doc.user/.project create mode 100644 plugins/org.yocto.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.doc.user/about.html.in create mode 100644 plugins/org.yocto.doc.user/build.properties create mode 100644 plugins/org.yocto.doc.user/html/book.css create mode 100644 plugins/org.yocto.doc.user/plugin.xml create mode 100644 plugins/org.yocto.doc.user/toc.xml create mode 100755 scripts/generate-doc.sh
Signature · 1 line
1.7.11.7
RFC v5 1/12 features/sdk.site: Fixed typo in category name
From: Timo Mueller <[email protected]>
--- features/org.yocto.sdk.site/site.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
features/org.yocto.sdk.site/site.xml +1 -1
@@ -10,5 +10,5 @@ <feature url="features/org.yocto.bc_@[email protected]" id="org.yocto.bc" version="@bcgenVerion@"> <category name="Yocto Project Bitbake Commander"/> </feature> - <category-def name="Yocto Project Bitbake Commander Plug-in" label="Yocto Project Bitbake Commander plug-in"/> + <category-def name="Yocto Project Bitbake Commander" label="Yocto Project Bitbake Commander plug-in"/> </site>
Signature · 1 line
1.7.11.7
RFC v5 2/12 Fixed typo in version variable name
From: Timo Mueller <[email protected]>
--- features/org.yocto.bc.headless.build/customTargets.xml | 4 ++-- features/org.yocto.sdk.headless.build/customTargets.xml | 4 ++-- features/org.yocto.sdk.site/category.xml | 6 +++--- features/org.yocto.sdk.site/site.xml | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-)
features/org.yocto.bc.headless.build/customTargets.xml +2 -2
@@ -81,7 +81,7 @@ <copy file="${otherSrcDirectory}/features/org.yocto.sdk.site/category.xml" todir="${buildDirectory}" /> <xmlproperty file="${otherSrcDirectory}/features/org.yocto.bc/feature.xml" /> <replace file="${buildDirectory}/category.xml"> - <replacefilter token="@bcfeatureVerion@" value="${feature(version)}"/> + <replacefilter token="@bcfeatureVersion@" value="${feature(version)}"/> </replace> </target>
@@ -177,7 +177,7 @@ <property file="${buildDirectory}/finalFeaturesVersions.properties" /> <copy file="${otherSrcDirectory}/features/org.yocto.sdk.site/site.xml" todir="${buildDirectory}" /> <replace file="${buildDirectory}/site.xml"> - <replacefilter token="@bcgenVerion@" value="${org.yocto.bc}"/> + <replacefilter token="@bcgenVersion@" value="${org.yocto.bc}"/> </replace> <zip destfile="${buildDirectory}/${buildLabel}/org.yocto.bc-${buildId}-group.group.group.zip" update="true"> <zipfileset dir="${buildDirectory}">
features/org.yocto.sdk.headless.build/customTargets.xml +2 -2
@@ -81,7 +81,7 @@ <copy file="${otherSrcDirectory}/features/org.yocto.sdk.site/category.xml" todir="${buildDirectory}" /> <xmlproperty file="${otherSrcDirectory}/features/org.yocto.sdk/feature.xml" /> <replace file="${buildDirectory}/category.xml"> - <replacefilter token="@featureVerion@" value="${feature(version)}"/> + <replacefilter token="@featureVersion@" value="${feature(version)}"/> </replace> </target>
@@ -177,7 +177,7 @@ <property file="${buildDirectory}/finalFeaturesVersions.properties" /> <copy file="${otherSrcDirectory}/features/org.yocto.sdk.site/site.xml" todir="${buildDirectory}" /> <replace file="${buildDirectory}/site.xml"> - <replacefilter token="@genVerion@" value="${org.yocto.sdk}"/> + <replacefilter token="@genVersion@" value="${org.yocto.sdk}"/> </replace> <zip destfile="${buildDirectory}/${buildLabel}/org.yocto.sdk-${buildId}-group.group.group.zip" update="true"> <zipfileset dir="${buildDirectory}">
features/org.yocto.sdk.site/category.xml +3 -3
@@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> <site> - <feature url="features/org.yocto.sdk_@[email protected]" id="org.yocto.sdk" version="@featureVerion@"> + <feature url="features/org.yocto.sdk_@[email protected]" id="org.yocto.sdk" version="@featureVersion@"> <category name="Yocto Project ADT"/> </feature> - <feature url="features/org.yocto.sdk.source_@[email protected]" id="org.yocto.sdk.source" version="@featureVerion@"> + <feature url="features/org.yocto.sdk.source_@[email protected]" id="org.yocto.sdk.source" version="@featureVersion@"> <category name="Yocto Project ADT"/> </feature> - <feature url="features/org.yocto.bc_@[email protected]" id="org.yocto.bc" version="@bcfeatureVerion@"> + <feature url="features/org.yocto.bc_@[email protected]" id="org.yocto.bc" version="@bcfeatureVersion@"> <category name="Yocto Project Bitbake Commander"/> </feature> <category-def name="Yocto Project ADT" label="Yocto Project ADT Plug-in"/>
features/org.yocto.sdk.site/site.xml +2 -2
@@ -3,11 +3,11 @@ <description name="Yocto Project update site" url="http://yoctoproject.org/downloads/eclipse-plugin/"> Yocto Project update site </description> - <feature url="features/org.yocto.sdk_@[email protected]" id="org.yocto.sdk" version="@genVerion@"> + <feature url="features/org.yocto.sdk_@[email protected]" id="org.yocto.sdk" version="@genVersion@"> <category name="Yocto Project ADT"/> </feature> <category-def name="Yocto Project ADT" label="Yocto Project ADT plug-in"/> - <feature url="features/org.yocto.bc_@[email protected]" id="org.yocto.bc" version="@bcgenVerion@"> + <feature url="features/org.yocto.bc_@[email protected]" id="org.yocto.bc" version="@bcgenVersion@"> <category name="Yocto Project Bitbake Commander"/> </feature> <category-def name="Yocto Project Bitbake Commander" label="Yocto Project Bitbake Commander plug-in"/>
Signature · 1 line
1.7.11.7
RFC v5 3/12 plugins/sdk.ide.doc.user: Add empty eclipse help
From: Timo Mueller <[email protected]>
Adds yocto specific eclipse help to the plugin. The help is currently empty but will contain the official yocto documentation later.
--- plugins/org.yocto.doc.user/.classpath | 6 +++++ plugins/org.yocto.doc.user/.project | 28 ++++++++++++++++++++++ plugins/org.yocto.doc.user/META-INF/MANIFEST.MF | 8 +++++++ .../OSGI-INF/l10n/bundle.properties | 3 +++ plugins/org.yocto.doc.user/build.properties | 7 ++++++ plugins/org.yocto.doc.user/html/book.css | 1 + plugins/org.yocto.doc.user/plugin.xml | 11 +++++++++ plugins/org.yocto.doc.user/toc.xml | 3 +++ 8 files changed, 67 insertions(+) create mode 100644 plugins/org.yocto.doc.user/.classpath create mode 100644 plugins/org.yocto.doc.user/.project create mode 100644 plugins/org.yocto.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.doc.user/build.properties create mode 100644 plugins/org.yocto.doc.user/html/book.css create mode 100644 plugins/org.yocto.doc.user/plugin.xml create mode 100644 plugins/org.yocto.doc.user/toc.xml
plugins/org.yocto.doc.user/.classpath new file +6 -0
@@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7"/> + <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> + <classpathentry kind="output" path="bin"/> +</classpath>
plugins/org.yocto.doc.user/.project new file +28 -0
@@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.yocto.doc.user</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.pde.ManifestBuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.pde.SchemaBuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.pde.PluginNature</nature> + <nature>org.eclipse.jdt.core.javanature</nature> + </natures> +</projectDescription>
plugins/org.yocto.doc.user/META-INF/MANIFEST.MF new file +8 -0
@@ -0,0 +1,8 @@ +XFManifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %Bundle-Name +Bundle-SymbolicName: org.yocto.doc.user;singleton:=true +Bundle-Version: 1.0.0.qualifier +Bundle-Vendor: %Bundle-Vendor +Bundle-RequiredExecutionEnvironment: JavaSE-1.6 +Require-Bundle: org.eclipse.help
plugins/org.yocto.doc.user/OSGI-INF/l10n/bundle.properties new file +3 -0
@@ -0,0 +1,3 @@ +#Properties file for org.yocto.doc.user +Bundle-Vendor = yoctoproject.org +Bundle-Name = Yocto Project Documentation
plugins/org.yocto.doc.user/build.properties new file +7 -0
@@ -0,0 +1,7 @@ +bin.includes = plugin.xml,\ + .,\ + META-INF/,\ + OSGI-INF/,\ + html/,\ + toc.xml +src.includes = html/
plugins/org.yocto.doc.user/html/book.css new file +1 -0
@@ -0,0 +1 @@ +@import "PLUGINS_ROOT/PRODUCT_PLUGIN/book.css";
plugins/org.yocto.doc.user/plugin.xml new file +11 -0
@@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?eclipse version="3.4"?> +<plugin> + <extension + point="org.eclipse.help.toc"> + <toc + file="toc.xml" + primary="true"> + </toc> + </extension> +</plugin>
plugins/org.yocto.doc.user/toc.xml new file +3 -0
@@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="UTF-8"?> + <toc label="Yocto Project Documentation"> + </toc>
Signature · 1 line
1.7.11.7
RFC v5 4/12 plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation
From: Timo Mueller <[email protected]>
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.doc.user/about.html.in | 189 ++++++++++++++++++++++++++++ plugins/org.yocto.doc.user/build.properties | 6 +- 2 files changed, 193 insertions(+), 2 deletions(-) create mode 100644 plugins/org.yocto.doc.user/about.html.in
plugins/org.yocto.doc.user/about.html.in new file +189 -0
@@ -0,0 +1,189 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> +<title>About</title> +</head> +<body lang="EN-US"> + <h2>About This Content</h2> + + <p> + <em>December, 2012</em> + </p> + <h3>License</h3> + + <p> + 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 <br /> + <a href="http://www.eclipse.org/legal/epl-v10.html"> + http://www.eclipse.org/legal/epl-v10.html + </a> + </p> + + <h3>Third Party Content</h3> + <p>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.</p> + <p> + <strong> + Yocto Project Quick Start + </strong> + <br /> + <br /> + This short document lets you get started with the Yocto Project + quickly and start building an image. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-yocto-project-qs@ + <br /> + <br /> + <strong> + Yocto Project Application Developer's Guide: + </strong> + <br /> + <br /> + 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. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-adt-manual@ + <br /> + <br /> + <strong> + Yocto Project Development Manual: + </strong> + <br /> + <br /> + This manual describes how to use the Yocto Project to develop + embedded Linux images and user-space applications to run on + targeted devices. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-dev-manual@ + <br /> + <br /> + <strong> + Yocto Project Reference Manual: + </strong> + <br /> + <br /> + This manual is the complete reference guide to the Poky component. + It also contains a chapter on Board Support Package (BSP) development. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-ref-manual@ + <br /> + <br /> + <strong> + Yocto Project Board Support Package (BSP) Developer's Guide: + </strong> + <br /> + <br /> + This brief document defines a structure for BSP components. + Having a commonly understood layout encourages standardization. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-bsp-guide@ + <br /> + <br /> + <strong> + Yocto Project Linux Kernel Development Manual: + </strong> + <br /> + <br /> + This document describes the architecture of the Yocto Project + kernel and provides some work flow examples. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-kernel-dev@ + <br /> + <br /> + <strong> + Yocto Project Profiling and Tracing Manual: + </strong> + <br /> + <br /> + This manual presents a set of common and generally useful + tracing and profiling schemes along with their application + (as appropriate) to each tool. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-profile-manual@ + </p> +</body>
plugins/org.yocto.doc.user/build.properties +4 -2
@@ -3,5 +3,7 @@ bin.includes = plugin.xml,\ META-INF/,\ OSGI-INF/,\ html/,\ - toc.xml -src.includes = html/ + toc.xml,\ + about.html +src.includes = html/,\ + about.html
Signature · 1 line
1.7.11.7
RFC v5 5/12 features/org.yocto.doc: Add new feature containing yocto project documentation
From: Timo Mueller <[email protected]>
--- features/org.yocto.doc/.project | 17 ++++ features/org.yocto.doc/build.properties | 3 + features/org.yocto.doc/feature.properties | 163 ++++++++++++++++++++++++++++++ features/org.yocto.doc/feature.xml | 35 +++++++ features/org.yocto.doc/license.html | 107 ++++++++++++++++++++ 5 files changed, 325 insertions(+) create mode 100644 features/org.yocto.doc/.project create mode 100644 features/org.yocto.doc/build.properties create mode 100644 features/org.yocto.doc/feature.properties create mode 100644 features/org.yocto.doc/feature.xml create mode 100644 features/org.yocto.doc/license.html
features/org.yocto.doc/.project new file +17 -0
@@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.yocto.doc</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.pde.FeatureBuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.pde.FeatureNature</nature> + </natures> +</projectDescription>
features/org.yocto.doc/build.properties new file +3 -0
@@ -0,0 +1,3 @@ +bin.includes = feature.xml,\ + license.html,\ + feature.properties
features/org.yocto.doc/feature.properties new file +163 -0
163 lines not on this page · raw message
features/org.yocto.doc/feature.xml new file +35 -0
@@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<feature + id="org.yocto.doc" + label="%featureName" + version="1.4.0.qualifier" + provider-name="%providerName"> + + <description> + %description + </description> + + <copyright> + %copyright + </copyright> + + <license url="%licenseURL"> + %license + </license> + + <url> + <update label="%updateSiteName" url="http://yoctoproject.org/downloads/eclipse-plugin/"/> + </url> + + <requires> + <import plugin="org.eclipse.help"/> + </requires> + + <plugin + id="org.yocto.doc.user" + download-size="0" + install-size="0" + version="0.0.0" + unpack="false"/> + +</feature>
features/org.yocto.doc/license.html new file +107 -0
107 lines not on this page · raw message
Signature · 1 line
1.7.11.7
RFC v5 6/12 features/doc.headless.build: Added headless build for yocto.doc feature
From: Timo Mueller <[email protected]>
--- features/org.yocto.doc.headless.build/.project | 11 + .../org.yocto.doc.headless.build/build.properties | 262 +++++++++++++++++++++ .../org.yocto.doc.headless.build/customTargets.xml | 212 +++++++++++++++++ 3 files changed, 485 insertions(+) create mode 100644 features/org.yocto.doc.headless.build/.project create mode 100644 features/org.yocto.doc.headless.build/build.properties create mode 100644 features/org.yocto.doc.headless.build/customTargets.xml
features/org.yocto.doc.headless.build/.project new file +11 -0
@@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.yocto.doc.headless.build</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + </buildSpec> + <natures> + </natures> +</projectDescription>
features/org.yocto.doc.headless.build/build.properties new file +262 -0
262 lines not on this page · raw message
features/org.yocto.doc.headless.build/customTargets.xml new file +212 -0
212 lines not on this page · raw message
Signature · 1 line
1.7.11.7
RFC v5 7/12 features/sdk.site: Added yocto.doc feature to update site
From: Timo Mueller <[email protected]>
--- features/org.yocto.sdk.site/category.xml | 4 ++++ features/org.yocto.sdk.site/site.xml | 4 ++++ 2 files changed, 8 insertions(+)
features/org.yocto.sdk.site/category.xml +4 -0
@@ -9,6 +9,10 @@ <feature url="features/org.yocto.bc_@[email protected]" id="org.yocto.bc" version="@bcfeatureVersion@"> <category name="Yocto Project Bitbake Commander"/> </feature> + <feature url="features/org.yocto.doc_@[email protected]" id="org.yocto.doc" version="@docFeatureVersion@"> + <category name="Yocto Project Documentation"/> + </feature> <category-def name="Yocto Project ADT" label="Yocto Project ADT Plug-in"/> <category-def name="Yocto Project Bitbake Commander" label="Yocto Project Bitbake Commander Plug-in"/> + <category-def name="Yocto Project Documentation" label="Yocto Project Documentation plug-in"/> </site>
features/org.yocto.sdk.site/site.xml +4 -0
@@ -11,4 +11,8 @@ <category name="Yocto Project Bitbake Commander"/> </feature> <category-def name="Yocto Project Bitbake Commander" label="Yocto Project Bitbake Commander plug-in"/> + <feature url="features/org.yocto.doc_@[email protected]" id="org.yocto.doc" version="@docGenVersion@"> + <category name="Yocto Project Documentation"/> + </feature> + <category-def name="Yocto Project Documentation" label="Yocto Project Documentation plug-in"/> </site>
Signature · 1 line
1.7.11.7
RFC v5 8/12 scripts/build.sh: Added yocto.doc feature to build
From: Timo Mueller <[email protected]>
--- scripts/build.sh | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-)
scripts/build.sh +9 -2
@@ -132,10 +132,14 @@ cd ${TOP} #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.doc.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" -if [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.sdk-${RELEASE}.zip ] && [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.bc-${RELEASE}.zip ]; then +if [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.sdk-${RELEASE}.zip ] && + [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.bc-${RELEASE}.zip ] && + [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.doc-${RELEASE}.zip ]; then cp -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.bc-${RELEASE}.zip ./org.yocto.bc-${RELEASE}-${DATE}.zip + cp -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.doc-${RELEASE}.zip ./org.yocto.doc-${RELEASE}-${DATE}.zip cp -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.sdk-${RELEASE}.zip ./org.yocto.sdk-${RELEASE}-${DATE}.zip rm -rf ${BUILD_DIR} else
@@ -144,10 +148,13 @@ fi #build archive for update site 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} -Dp2.gathering=true || fail $? "archive build" +java -jar ${LAUNCHER} -application org.eclipse.ant.core.antRunner -buildfile ${BUILDFILE} -DbaseLocation=${ECLIPSE_BASE} -Dbuilder=${GIT_DIR}/features/org.yocto.doc.headless.build -DbuildDirectory=${BUILD_DIR} -DotherSrcDirectory=${GIT_DIR} -DbuildId=${RELEASE} -Dp2.gathering=true || fail $? "archive 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} -Dp2.gathering=true || fail $? "archive build" #clean up -if [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.sdk-${RELEASE}-group.group.group.zip ] && [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.bc-${RELEASE}-group.group.group.zip ]; then +if [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.sdk-${RELEASE}-group.group.group.zip ] && + [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.bc-${RELEASE}-group.group.group.zip ] && + [ -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.doc-${RELEASE}-group.group.group.zip ]; then cp -f ${BUILD_DIR}/I.${RELEASE}/org.yocto.sdk-${RELEASE}-group.group.group.zip ./org.yocto.sdk-${RELEASE}-${DATE}-archive.zip rm -rf ${BUILD_TOP} else
Signature · 1 line
1.7.11.7
RFC v5 9/12 scripts/generate-doc.sh: Add script to handle eclipse help generation
From: Timo Mueller <[email protected]>
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 | 85 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100755 scripts/generate-doc.sh
scripts/generate-doc.sh new file +85 -0
@@ -0,0 +1,85 @@ +#!/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=`readlink -f $2` + +TOP=`pwd` + +DOC_DIR=${PLUGIN_FOLDER}/docs +rm -rf ${DOC_DIR} +DOC_PLUGIN_DIR=${PLUGIN_FOLDER}/plugins/org.yocto.doc.user +DOC_HTML_DIR=${DOC_PLUGIN_DIR}/html/ + +# git clone +#DOC_GIT=git://git.yoctoproject.org/yocto-docs.git +DOC_GIT=file:///home/timo/_dev/oss/yocto/yocto-docs +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-dev \ + bsp-guide ref-manual dev-manual profile-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}
Signature · 1 line
1.7.11.7
RFC v5 10/12 plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents
From: Timo Mueller <[email protected]>
The separate yocto manuals are added to the table of contents to prepare their inclusion into the plugin.
--- plugins/org.yocto.doc.user/plugin.xml | 28 ++++++++++++++++++++++++++++ plugins/org.yocto.doc.user/toc.xml | 21 +++++++++++++++++++++ 2 files changed, 49 insertions(+)
plugins/org.yocto.doc.user/plugin.xml +28 -0
@@ -7,5 +7,33 @@ file="toc.xml" primary="true"> </toc> + <toc + file="html/adt-manual-toc.xml" + primary="false"> + </toc> + <toc + file="html/yocto-project-qs-toc.xml" + primary="false"> + </toc> + <toc + file="html/dev-manual-toc.xml" + primary="false"> + </toc> + <toc + file="html/ref-manual-toc.xml" + primary="false"> + </toc> + <toc + file="html/bsp-guide-toc.xml" + primary="false"> + </toc> + <toc + file="html/kernel-dev-toc.xml" + primary="false"> + </toc> + <toc + file="html/profile-manual-toc.xml" + primary="false"> + </toc> </extension> </plugin>
plugins/org.yocto.doc.user/toc.xml +21 -0
@@ -1,3 +1,24 @@ <?xml version="1.0" encoding="UTF-8"?> <toc label="Yocto Project Documentation"> + <topic label="Yocto Project Quick Start"> + <link toc="html/yocto-project-qs-toc.xml"/> + </topic> + <topic label="Yocto·Project·Application·Developer's·Guide"> + <link toc="html/adt-manual-toc.xml"/> + </topic> + <topic label="Yocto Project Development Manual"> + <link toc="html/dev-manual-toc.xml"/> + </topic> + <topic label="Yocto Project Reference Manual"> + <link toc="html/ref-manual-toc.xml"/> + </topic> + <topic label="Yocto Project Board Support Package Developer's Guide"> + <link toc="html/bsp-guide-toc.xml"/> + </topic> + <topic label="Yocto Project Linux Kernel Development Manual"> + <link toc="html/kernel-dev-toc.xml"/> + </topic> + <topic label="Yocto Project Tracing and Profiling Manual"> + <link toc="html/profile-manual-toc.xml"/> + </topic> </toc>
Signature · 1 line
1.7.11.7
RFC v5 11/12 scripts/generate-doc.sh: Copy generated eclipse help into the user.doc plugin
From: Timo Mueller <[email protected]>
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 file changed, 2 insertions(+)
scripts/generate-doc.sh +2 -0
@@ -78,6 +78,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
Signature · 1 line
1.7.11.7
RFC v5 12/12 scripts/build.sh: Add documentation generation to the default build
From: Timo Mueller <[email protected]>
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 file changed, 7 insertions(+)
scripts/build.sh +7 -0
@@ -130,6 +130,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.doc.headless.build -DbuildDirectory=${BUILD_DIR} -DotherSrcDirectory=${GIT_DIR} -DbuildId=${RELEASE} || fail $? "normal build"
Signature · 1 line
1.7.11.7
Hi Timo,
Thanks, these are merged into eclipse-poky master with the following patch to address an issue in your original patches :-)
Cheers,
Jessica
Fixed the DOC_GIT hard coded issueHEADmaster
Diffstat
-rwxr-xr-x scripts/generate-doc.sh 3
1 files changed, 1 insertions, 2 deletions
scripts/generate-doc.sh +0 -0
@@ -56,8 +56,7 @@ DOC_PLUGIN_DIR=${PLUGIN_FOLDER}/plugins/org.yocto.doc.user
DOC_HTML_DIR=${DOC_PLUGIN_DIR}/html/
# git clone
-#DOC_GIT=git://git.yoctoproject.org/yocto-docs.git
-DOC_GIT=file:///home/timo/_dev/oss/yocto/yocto-docs
+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}"-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Timo Mueller
Sent: Friday, February 08, 2013 5:25 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse
From: Timo Mueller <[email protected]>
v5: Incorporates changes resulting from the renaming of documentation and adds the profile-manual. This patch set requires changes proposed in "[PATCH][yocto-docs] Update eclipse help generation to support all documents"
From RFC v4:
Hi,
the last proposal integrated the yocto documentation into the existing doc plugin of the yocto ADT feature. As Jessica pointed out is does not make sense to bundle all parts of the yocto documentation with the ADT feature. As some parts of the documentation could also be helpful with the BitBake Commander feature, we agreed to encapsulate the yocto documentation into its own feature.
01..02: Fixing typos in build and site scripts
03..12: Adding the yocto documentation as a new feature 13: Temporary patch to use timo branch of docs project - DO NOT MERGE
From the last propsal:
<snip>
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. </snip>
<snip>
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. </snip>
<snip>
I have intergrated this
documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). </snip>
Best regards
Timo
Timo Mueller (12):
features/sdk.site: Fixed typo in category name
Fixed typo in version variable name plugins/sdk.ide.doc.user: Add empty eclipse help plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto
documentation
features/org.yocto.doc: Add new feature containing yocto project
documentation
features/doc.headless.build: Added headless build for yocto.doc
feature
features/sdk.site: Added yocto.doc feature to update site scripts/build.sh: Added yocto.doc feature to build 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/generate-doc.sh: Copy generated eclipse help into the
user.doc plugin
scripts/build.sh: Add documentation generation to the default build
.../org.yocto.bc.headless.build/customTargets.xml | 4 +- features/org.yocto.doc.headless.build/.project | 11 + .../org.yocto.doc.headless.build/build.properties | 262 +++++++++++++++++++++ .../org.yocto.doc.headless.build/customTargets.xml | 212 +++++++++++++++++ features/org.yocto.doc/.project | 17 ++ features/org.yocto.doc/build.properties | 3 + features/org.yocto.doc/feature.properties | 163 +++++++++++++ features/org.yocto.doc/feature.xml | 35 +++ features/org.yocto.doc/license.html | 107 +++++++++ .../org.yocto.sdk.headless.build/customTargets.xml | 4 +- features/org.yocto.sdk.site/category.xml | 10 +- features/org.yocto.sdk.site/site.xml | 10 +- plugins/org.yocto.doc.user/.classpath | 6 + plugins/org.yocto.doc.user/.project | 28 +++ plugins/org.yocto.doc.user/META-INF/MANIFEST.MF | 8 + .../OSGI-INF/l10n/bundle.properties | 3 + plugins/org.yocto.doc.user/about.html.in | 189 +++++++++++++++ plugins/org.yocto.doc.user/build.properties | 9 + plugins/org.yocto.doc.user/html/book.css | 1 + plugins/org.yocto.doc.user/plugin.xml | 39 +++ plugins/org.yocto.doc.user/toc.xml | 24 ++ scripts/build.sh | 18 +- scripts/generate-doc.sh | 87 +++++++ 23 files changed, 1238 insertions(+), 12 deletions(-) create mode 100644 features/org.yocto.doc.headless.build/.project create mode 100644 features/org.yocto.doc.headless.build/build.properties create mode 100644 features/org.yocto.doc.headless.build/customTargets.xml create mode 100644 features/org.yocto.doc/.project create mode 100644 features/org.yocto.doc/build.properties create mode 100644 features/org.yocto.doc/feature.properties create mode 100644 features/org.yocto.doc/feature.xml create mode 100644 features/org.yocto.doc/license.html create mode 100644 plugins/org.yocto.doc.user/.classpath create mode 100644 plugins/org.yocto.doc.user/.project create mode 100644 plugins/org.yocto.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.doc.user/about.html.in create mode 100644 plugins/org.yocto.doc.user/build.properties create mode 100644 plugins/org.yocto.doc.user/html/book.css create mode 100644 plugins/org.yocto.doc.user/plugin.xml create mode 100644 plugins/org.yocto.doc.user/toc.xml create mode 100755 scripts/generate-doc.sh
--
1.7.11.7
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto