* [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse
@ 2013-02-08 13:24 Timo Mueller
2013-02-08 13:24 ` [RFC v5 01/12] features/sdk.site: Fixed typo in category name Timo Mueller
2013-02-08 21:03 ` [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse Zhang, Jessica
0 siblings, 2 replies; 14+ messages in thread
From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw)
To: yocto; +Cc: Timo Mueller
From: Timo Mueller <timo.mueller@bmw-carit.de>
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
^ permalink raw reply [flat|nested] 14+ messages in thread* [RFC v5 01/12] features/sdk.site: Fixed typo in category name 2013-02-08 13:24 [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 02/12] Fixed typo in version variable name Timo Mueller 2013-02-08 21:03 ` [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse Zhang, Jessica 1 sibling, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- features/org.yocto.sdk.site/site.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/features/org.yocto.sdk.site/site.xml b/features/org.yocto.sdk.site/site.xml index 824fa49..c2af2bd 100644 --- a/features/org.yocto.sdk.site/site.xml +++ b/features/org.yocto.sdk.site/site.xml @@ -10,5 +10,5 @@ <feature url="features/org.yocto.bc_@bcgenVerion@.jar" 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> -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 02/12] Fixed typo in version variable name 2013-02-08 13:24 ` [RFC v5 01/12] features/sdk.site: Fixed typo in category name Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 03/12] plugins/sdk.ide.doc.user: Add empty eclipse help Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- 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(-) diff --git a/features/org.yocto.bc.headless.build/customTargets.xml b/features/org.yocto.bc.headless.build/customTargets.xml index a3c87ff..b6d7ed7 100644 --- a/features/org.yocto.bc.headless.build/customTargets.xml +++ b/features/org.yocto.bc.headless.build/customTargets.xml @@ -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}"> diff --git a/features/org.yocto.sdk.headless.build/customTargets.xml b/features/org.yocto.sdk.headless.build/customTargets.xml index 45cb4c9..cb08f91 100644 --- a/features/org.yocto.sdk.headless.build/customTargets.xml +++ b/features/org.yocto.sdk.headless.build/customTargets.xml @@ -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}"> diff --git a/features/org.yocto.sdk.site/category.xml b/features/org.yocto.sdk.site/category.xml index 6b1812c..6466ea5 100644 --- a/features/org.yocto.sdk.site/category.xml +++ b/features/org.yocto.sdk.site/category.xml @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> <site> - <feature url="features/org.yocto.sdk_@featureVerion@.jar" id="org.yocto.sdk" version="@featureVerion@"> + <feature url="features/org.yocto.sdk_@featureVersion@.jar" id="org.yocto.sdk" version="@featureVersion@"> <category name="Yocto Project ADT"/> </feature> - <feature url="features/org.yocto.sdk.source_@featureVerion@.jar" id="org.yocto.sdk.source" version="@featureVerion@"> + <feature url="features/org.yocto.sdk.source_@featureVersion@.jar" id="org.yocto.sdk.source" version="@featureVersion@"> <category name="Yocto Project ADT"/> </feature> - <feature url="features/org.yocto.bc_@bcfeatureVerion@.jar" id="org.yocto.bc" version="@bcfeatureVerion@"> + <feature url="features/org.yocto.bc_@bcfeatureVersion@.jar" 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"/> diff --git a/features/org.yocto.sdk.site/site.xml b/features/org.yocto.sdk.site/site.xml index c2af2bd..d477279 100644 --- a/features/org.yocto.sdk.site/site.xml +++ b/features/org.yocto.sdk.site/site.xml @@ -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_@genVerion@.jar" id="org.yocto.sdk" version="@genVerion@"> + <feature url="features/org.yocto.sdk_@genVersion@.jar" 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_@bcgenVerion@.jar" id="org.yocto.bc" version="@bcgenVerion@"> + <feature url="features/org.yocto.bc_@bcgenVersion@.jar" 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"/> -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 03/12] plugins/sdk.ide.doc.user: Add empty eclipse help 2013-02-08 13:24 ` [RFC v5 02/12] Fixed typo in version variable name Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 04/12] plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> Adds yocto specific eclipse help to the plugin. The help is currently empty but will contain the official yocto documentation later. Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- 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 diff --git a/plugins/org.yocto.doc.user/.classpath b/plugins/org.yocto.doc.user/.classpath new file mode 100644 index 0000000..67e2a52 --- /dev/null +++ b/plugins/org.yocto.doc.user/.classpath @@ -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> diff --git a/plugins/org.yocto.doc.user/.project b/plugins/org.yocto.doc.user/.project new file mode 100644 index 0000000..d46bf21 --- /dev/null +++ b/plugins/org.yocto.doc.user/.project @@ -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> diff --git a/plugins/org.yocto.doc.user/META-INF/MANIFEST.MF b/plugins/org.yocto.doc.user/META-INF/MANIFEST.MF new file mode 100644 index 0000000..4a89341 --- /dev/null +++ b/plugins/org.yocto.doc.user/META-INF/MANIFEST.MF @@ -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 diff --git a/plugins/org.yocto.doc.user/OSGI-INF/l10n/bundle.properties b/plugins/org.yocto.doc.user/OSGI-INF/l10n/bundle.properties new file mode 100644 index 0000000..b602cbd --- /dev/null +++ b/plugins/org.yocto.doc.user/OSGI-INF/l10n/bundle.properties @@ -0,0 +1,3 @@ +#Properties file for org.yocto.doc.user +Bundle-Vendor = yoctoproject.org +Bundle-Name = Yocto Project Documentation diff --git a/plugins/org.yocto.doc.user/build.properties b/plugins/org.yocto.doc.user/build.properties new file mode 100644 index 0000000..525a366 --- /dev/null +++ b/plugins/org.yocto.doc.user/build.properties @@ -0,0 +1,7 @@ +bin.includes = plugin.xml,\ + .,\ + META-INF/,\ + OSGI-INF/,\ + html/,\ + toc.xml +src.includes = html/ diff --git a/plugins/org.yocto.doc.user/html/book.css b/plugins/org.yocto.doc.user/html/book.css new file mode 100644 index 0000000..e248f5a --- /dev/null +++ b/plugins/org.yocto.doc.user/html/book.css @@ -0,0 +1 @@ +@import "PLUGINS_ROOT/PRODUCT_PLUGIN/book.css"; diff --git a/plugins/org.yocto.doc.user/plugin.xml b/plugins/org.yocto.doc.user/plugin.xml new file mode 100644 index 0000000..8353cd1 --- /dev/null +++ b/plugins/org.yocto.doc.user/plugin.xml @@ -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> diff --git a/plugins/org.yocto.doc.user/toc.xml b/plugins/org.yocto.doc.user/toc.xml new file mode 100644 index 0000000..4998ef3 --- /dev/null +++ b/plugins/org.yocto.doc.user/toc.xml @@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="UTF-8"?> + <toc label="Yocto Project Documentation"> + </toc> -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 04/12] plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation 2013-02-08 13:24 ` [RFC v5 03/12] plugins/sdk.ide.doc.user: Add empty eclipse help Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 05/12] features/org.yocto.doc: Add new feature containing yocto project documentation Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> 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. Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- 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 diff --git a/plugins/org.yocto.doc.user/about.html.in b/plugins/org.yocto.doc.user/about.html.in new file mode 100644 index 0000000..3040859 --- /dev/null +++ b/plugins/org.yocto.doc.user/about.html.in @@ -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> diff --git a/plugins/org.yocto.doc.user/build.properties b/plugins/org.yocto.doc.user/build.properties index 525a366..cbceb14 100644 --- a/plugins/org.yocto.doc.user/build.properties +++ b/plugins/org.yocto.doc.user/build.properties @@ -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 -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 05/12] features/org.yocto.doc: Add new feature containing yocto project documentation 2013-02-08 13:24 ` [RFC v5 04/12] plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 06/12] features/doc.headless.build: Added headless build for yocto.doc feature Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- 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 diff --git a/features/org.yocto.doc/.project b/features/org.yocto.doc/.project new file mode 100644 index 0000000..2ad46a8 --- /dev/null +++ b/features/org.yocto.doc/.project @@ -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> diff --git a/features/org.yocto.doc/build.properties b/features/org.yocto.doc/build.properties new file mode 100644 index 0000000..52c3cfc --- /dev/null +++ b/features/org.yocto.doc/build.properties @@ -0,0 +1,3 @@ +bin.includes = feature.xml,\ + license.html,\ + feature.properties diff --git a/features/org.yocto.doc/feature.properties b/features/org.yocto.doc/feature.properties new file mode 100644 index 0000000..46883e8 --- /dev/null +++ b/features/org.yocto.doc/feature.properties @@ -0,0 +1,163 @@ +############################################################################### +# 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 +# +# Contributors: +# Intel - initial implementation +############################################################################### + +# "featureName" property - name of the feature +featureName=Yocto Project Documentation Plug-in + +# "providerName" property - name of the company that provides the feature +providerName=yoctoproject.org + +# "updateSiteName" property - label for the update site +updateSiteName=Yocto Project Update Site + +# "description" property - description of the feature +description=\ +Eclipse plug-in containing the documentation of the Yocto Project + +# copyright +copyright=\ +Copyright (c) 2013 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 +################ end of copyright property #################################### + +# "licenseURL" property - URL of the "Feature License" +# do not translate value - just change to point to a locale-specific HTML page +licenseURL=license.html + +# "license" property - text of the "Feature Update License" +# should be plain text version of license agreement pointed to be "licenseURL" +license=\ +Eclipse Foundation Software User Agreement\n\ +April 14, 2010\n\ +\n\ +Usage Of Content\n\ +\n\ +THE ECLIPSE FOUNDATION MAKES AVAILABLE SOFTWARE, DOCUMENTATION, INFORMATION AND/OR\n\ +OTHER MATERIALS FOR OPEN SOURCE PROJECTS (COLLECTIVELY "CONTENT").\n\ +USE OF THE CONTENT IS GOVERNED BY THE TERMS AND CONDITIONS OF THIS\n\ +AGREEMENT AND/OR THE TERMS AND CONDITIONS OF LICENSE AGREEMENTS OR\n\ +NOTICES INDICATED OR REFERENCED BELOW. BY USING THE CONTENT, YOU\n\ +AGREE THAT YOUR USE OF THE CONTENT IS GOVERNED BY THIS AGREEMENT\n\ +AND/OR THE TERMS AND CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS\n\ +OR NOTICES INDICATED OR REFERENCED BELOW. IF YOU DO NOT AGREE TO THE\n\ +TERMS AND CONDITIONS OF THIS AGREEMENT AND THE TERMS AND CONDITIONS\n\ +OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED\n\ +BELOW, THEN YOU MAY NOT USE THE CONTENT.\n\ +\n\ +Applicable Licenses\n\ +\n\ +Unless otherwise indicated, all Content made available by the\n\ +Eclipse Foundation is provided to you under the terms and conditions of\n\ +the Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is\n\ +provided with this Content and is also available at http://www.eclipse.org/legal/epl-v10.html.\n\ +For purposes of the EPL, "Program" will mean the Content.\n\ +\n\ +Content includes, but is not limited to, source code, object code,\n\ +documentation and other files maintained in the Eclipse Foundation source code\n\ +repository ("Repository") in software modules ("Modules") and made available\n\ +as downloadable archives ("Downloads").\n\ +\n\ + - Content may be structured and packaged into modules to facilitate delivering,\n\ + extending, and upgrading the Content. Typical modules may include plug-ins ("Plug-ins"),\n\ + plug-in fragments ("Fragments"), and features ("Features").\n\ + - Each Plug-in or Fragment may be packaged as a sub-directory or JAR (Java(TM) ARchive)\n\ + in a directory named "plugins".\n\ + - A Feature is a bundle of one or more Plug-ins and/or Fragments and associated material.\n\ + Each Feature may be packaged as a sub-directory in a directory named "features".\n\ + Within a Feature, files named "feature.xml" may contain a list of the names and version\n\ + numbers of the Plug-ins and/or Fragments associated with that Feature.\n\ + - Features may also include other Features ("Included Features"). Within a Feature, files\n\ + named "feature.xml" may contain a list of the names and version numbers of Included Features.\n\ +\n\ +The terms and conditions governing Plug-ins and Fragments should be\n\ +contained in files named "about.html" ("Abouts"). The terms and\n\ +conditions governing Features and Included Features should be contained\n\ +in files named "license.html" ("Feature Licenses"). Abouts and Feature\n\ +Licenses may be located in any directory of a Download or Module\n\ +including, but not limited to the following locations:\n\ +\n\ + - The top-level (root) directory\n\ + - Plug-in and Fragment directories\n\ + - Inside Plug-ins and Fragments packaged as JARs\n\ + - Sub-directories of the directory named "src" of certain Plug-ins\n\ + - Feature directories\n\ +\n\ +Note: if a Feature made available by the Eclipse Foundation is installed using the\n\ +Provisioning Technology (as defined below), you must agree to a license ("Feature \n\ +Update License") during the installation process. If the Feature contains\n\ +Included Features, the Feature Update License should either provide you\n\ +with the terms and conditions governing the Included Features or inform\n\ +you where you can locate them. Feature Update Licenses may be found in\n\ +the "license" property of files named "feature.properties" found within a Feature.\n\ +Such Abouts, Feature Licenses, and Feature Update Licenses contain the\n\ +terms and conditions (or references to such terms and conditions) that\n\ +govern your use of the associated Content in that directory.\n\ +\n\ +THE ABOUTS, FEATURE LICENSES, AND FEATURE UPDATE LICENSES MAY REFER\n\ +TO THE EPL OR OTHER LICENSE AGREEMENTS, NOTICES OR TERMS AND CONDITIONS.\n\ +SOME OF THESE OTHER LICENSE AGREEMENTS MAY INCLUDE (BUT ARE NOT LIMITED TO):\n\ +\n\ + - Common Public License Version 1.0 (available at http://www.eclipse.org/legal/cpl-v10.html)\n\ + - Apache Software License 1.1 (available at http://www.apache.org/licenses/LICENSE)\n\ + - Apache Software License 2.0 (available at http://www.apache.org/licenses/LICENSE-2.0)\n\ + - Metro Link Public License 1.00 (available at http://www.opengroup.org/openmotif/supporters/metrolink/license.html)\n\ + - Mozilla Public License Version 1.1 (available at http://www.mozilla.org/MPL/MPL-1.1.html)\n\ +\n\ +IT IS YOUR OBLIGATION TO READ AND ACCEPT ALL SUCH TERMS AND CONDITIONS PRIOR\n\ +TO USE OF THE CONTENT. If no About, Feature License, or Feature Update License\n\ +is provided, please contact the Eclipse Foundation to determine what terms and conditions\n\ +govern that particular Content.\n\ +\n\ +\n\Use of Provisioning Technology\n\ +\n\ +The Eclipse Foundation makes available provisioning software, examples of which include,\n\ +but are not limited to, p2 and the Eclipse Update Manager ("Provisioning Technology") for\n\ +the purpose of allowing users to install software, documentation, information and/or\n\ +other materials (collectively "Installable Software"). This capability is provided with\n\ +the intent of allowing such users to install, extend and update Eclipse-based products.\n\ +Information about packaging Installable Software is available at\n\ +http://eclipse.org/equinox/p2/repository_packaging.html ("Specification").\n\ +\n\ +You may use Provisioning Technology to allow other parties to install Installable Software.\n\ +You shall be responsible for enabling the applicable license agreements relating to the\n\ +Installable Software to be presented to, and accepted by, the users of the Provisioning Technology\n\ +in accordance with the Specification. By using Provisioning Technology in such a manner and\n\ +making it available in accordance with the Specification, you further acknowledge your\n\ +agreement to, and the acquisition of all necessary rights to permit the following:\n\ +\n\ + 1. A series of actions may occur ("Provisioning Process") in which a user may execute\n\ + the Provisioning Technology on a machine ("Target Machine") with the intent of installing,\n\ + extending or updating the functionality of an Eclipse-based product.\n\ + 2. During the Provisioning Process, the Provisioning Technology may cause third party\n\ + Installable Software or a portion thereof to be accessed and copied to the Target Machine.\n\ + 3. Pursuant to the Specification, you will provide to the user the terms and conditions that\n\ + govern the use of the Installable Software ("Installable Software Agreement") and such\n\ + Installable Software Agreement shall be accessed from the Target Machine in accordance\n\ + with the Specification. Such Installable Software Agreement must inform the user of the\n\ + terms and conditions that govern the Installable Software and must solicit acceptance by\n\ + the end user in the manner prescribed in such Installable Software Agreement. Upon such\n\ + indication of agreement by the user, the provisioning Technology will complete installation\n\ + of the Installable Software.\n\ +\n\ +Cryptography\n\ +\n\ +Content may contain encryption software. The country in which you are\n\ +currently may have restrictions on the import, possession, and use,\n\ +and/or re-export to another country, of encryption software. BEFORE\n\ +using any encryption software, please check the country's laws,\n\ +regulations and policies concerning the import, possession, or use, and\n\ +re-export of encryption software, to see if this is permitted.\n\ +\n\ +Java and all Java-based trademarks are trademarks of Oracle Corporation in the United States, other countries, or both.\n +########### end of license property ########################################## diff --git a/features/org.yocto.doc/feature.xml b/features/org.yocto.doc/feature.xml new file mode 100644 index 0000000..ed8687e --- /dev/null +++ b/features/org.yocto.doc/feature.xml @@ -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> diff --git a/features/org.yocto.doc/license.html b/features/org.yocto.doc/license.html new file mode 100644 index 0000000..c184ca3 --- /dev/null +++ b/features/org.yocto.doc/license.html @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="ISO-8859-1" ?> +<!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>Eclipse Foundation Software User Agreement</title> +</head> + +<body lang="EN-US"> +<h2>Eclipse Foundation Software User Agreement</h2> +<p>April 14, 2010</p> + +<h3>Usage Of Content</h3> + +<p>THE ECLIPSE FOUNDATION MAKES AVAILABLE SOFTWARE, DOCUMENTATION, INFORMATION AND/OR OTHER MATERIALS FOR OPEN SOURCE PROJECTS + (COLLECTIVELY "CONTENT"). USE OF THE CONTENT IS GOVERNED BY THE TERMS AND CONDITIONS OF THIS AGREEMENT AND/OR THE TERMS AND + CONDITIONS OF LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW. BY USING THE CONTENT, YOU AGREE THAT YOUR USE + OF THE CONTENT IS GOVERNED BY THIS AGREEMENT AND/OR THE TERMS AND CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS OR + NOTICES INDICATED OR REFERENCED BELOW. IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT AND THE TERMS AND + CONDITIONS OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW, THEN YOU MAY NOT USE THE CONTENT.</p> + +<h3>Applicable Licenses</h3> + +<p>Unless otherwise indicated, all Content made available by the Eclipse Foundation is provided to you under the terms and conditions of the Eclipse Public License Version 1.0 + ("EPL"). A copy of the EPL is provided with this Content and is also available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>. + For purposes of the EPL, "Program" will mean the Content.</p> + +<p>Content includes, but is not limited to, source code, object code, documentation and other files maintained in the Eclipse Foundation source code + repository ("Repository") in software modules ("Modules") and made available as downloadable archives ("Downloads").</p> + +<ul> + <li>Content may be structured and packaged into modules to facilitate delivering, extending, and upgrading the Content. Typical modules may include plug-ins ("Plug-ins"), plug-in fragments ("Fragments"), and features ("Features").</li> + <li>Each Plug-in or Fragment may be packaged as a sub-directory or JAR (Java™ ARchive) in a directory named "plugins".</li> + <li>A Feature is a bundle of one or more Plug-ins and/or Fragments and associated material. Each Feature may be packaged as a sub-directory in a directory named "features". Within a Feature, files named "feature.xml" may contain a list of the names and version numbers of the Plug-ins + and/or Fragments associated with that Feature.</li> + <li>Features may also include other Features ("Included Features"). Within a Feature, files named "feature.xml" may contain a list of the names and version numbers of Included Features.</li> +</ul> + +<p>The terms and conditions governing Plug-ins and Fragments should be contained in files named "about.html" ("Abouts"). The terms and conditions governing Features and +Included Features should be contained in files named "license.html" ("Feature Licenses"). Abouts and Feature Licenses may be located in any directory of a Download or Module +including, but not limited to the following locations:</p> + +<ul> + <li>The top-level (root) directory</li> + <li>Plug-in and Fragment directories</li> + <li>Inside Plug-ins and Fragments packaged as JARs</li> + <li>Sub-directories of the directory named "src" of certain Plug-ins</li> + <li>Feature directories</li> +</ul> + +<p>Note: if a Feature made available by the Eclipse Foundation is installed using the Provisioning Technology (as defined below), you must agree to a license ("Feature Update License") during the +installation process. If the Feature contains Included Features, the Feature Update License should either provide you with the terms and conditions governing the Included Features or +inform you where you can locate them. Feature Update Licenses may be found in the "license" property of files named "feature.properties" found within a Feature. +Such Abouts, Feature Licenses, and Feature Update Licenses contain the terms and conditions (or references to such terms and conditions) that govern your use of the associated Content in +that directory.</p> + +<p>THE ABOUTS, FEATURE LICENSES, AND FEATURE UPDATE LICENSES MAY REFER TO THE EPL OR OTHER LICENSE AGREEMENTS, NOTICES OR TERMS AND CONDITIONS. SOME OF THESE +OTHER LICENSE AGREEMENTS MAY INCLUDE (BUT ARE NOT LIMITED TO):</p> + +<ul> + <li>Common Public License Version 1.0 (available at <a href="http://www.eclipse.org/legal/cpl-v10.html">http://www.eclipse.org/legal/cpl-v10.html</a>)</li> + <li>Apache Software License 1.1 (available at <a href="http://www.apache.org/licenses/LICENSE">http://www.apache.org/licenses/LICENSE</a>)</li> + <li>Apache Software License 2.0 (available at <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>)</li> + <li>Metro Link Public License 1.00 (available at <a href="http://www.opengroup.org/openmotif/supporters/metrolink/license.html">http://www.opengroup.org/openmotif/supporters/metrolink/license.html</a>)</li> + <li>Mozilla Public License Version 1.1 (available at <a href="http://www.mozilla.org/MPL/MPL-1.1.html">http://www.mozilla.org/MPL/MPL-1.1.html</a>)</li> +</ul> + +<p>IT IS YOUR OBLIGATION TO READ AND ACCEPT ALL SUCH TERMS AND CONDITIONS PRIOR TO USE OF THE CONTENT. If no About, Feature License, or Feature Update License is provided, please +contact the Eclipse Foundation to determine what terms and conditions govern that particular Content.</p> + + +<h3>Use of Provisioning Technology</h3> + +<p>The Eclipse Foundation makes available provisioning software, examples of which include, but are not limited to, p2 and the Eclipse + Update Manager ("Provisioning Technology") for the purpose of allowing users to install software, documentation, information and/or + other materials (collectively "Installable Software"). This capability is provided with the intent of allowing such users to + install, extend and update Eclipse-based products. Information about packaging Installable Software is available at <a + href="http://eclipse.org/equinox/p2/repository_packaging.html">http://eclipse.org/equinox/p2/repository_packaging.html</a> + ("Specification").</p> + +<p>You may use Provisioning Technology to allow other parties to install Installable Software. You shall be responsible for enabling the + applicable license agreements relating to the Installable Software to be presented to, and accepted by, the users of the Provisioning Technology + in accordance with the Specification. By using Provisioning Technology in such a manner and making it available in accordance with the + Specification, you further acknowledge your agreement to, and the acquisition of all necessary rights to permit the following:</p> + +<ol> + <li>A series of actions may occur ("Provisioning Process") in which a user may execute the Provisioning Technology + on a machine ("Target Machine") with the intent of installing, extending or updating the functionality of an Eclipse-based + product.</li> + <li>During the Provisioning Process, the Provisioning Technology may cause third party Installable Software or a portion thereof to be + accessed and copied to the Target Machine.</li> + <li>Pursuant to the Specification, you will provide to the user the terms and conditions that govern the use of the Installable + Software ("Installable Software Agreement") and such Installable Software Agreement shall be accessed from the Target + Machine in accordance with the Specification. Such Installable Software Agreement must inform the user of the terms and conditions that govern + the Installable Software and must solicit acceptance by the end user in the manner prescribed in such Installable Software Agreement. Upon such + indication of agreement by the user, the provisioning Technology will complete installation of the Installable Software.</li> +</ol> + +<h3>Cryptography</h3> + +<p>Content may contain encryption software. The country in which you are currently may have restrictions on the import, possession, and use, and/or re-export to + another country, of encryption software. BEFORE using any encryption software, please check the country's laws, regulations and policies concerning the import, + possession, or use, and re-export of encryption software, to see if this is permitted.</p> + +<p><small>Java and all Java-based trademarks are trademarks of Oracle Corporation in the United States, other countries, or both.</small></p> +</body> +</html> -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 06/12] features/doc.headless.build: Added headless build for yocto.doc feature 2013-02-08 13:24 ` [RFC v5 05/12] features/org.yocto.doc: Add new feature containing yocto project documentation Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 07/12] features/sdk.site: Added yocto.doc feature to update site Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- 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 diff --git a/features/org.yocto.doc.headless.build/.project b/features/org.yocto.doc.headless.build/.project new file mode 100644 index 0000000..106c772 --- /dev/null +++ b/features/org.yocto.doc.headless.build/.project @@ -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> diff --git a/features/org.yocto.doc.headless.build/build.properties b/features/org.yocto.doc.headless.build/build.properties new file mode 100644 index 0000000..6a857f8 --- /dev/null +++ b/features/org.yocto.doc.headless.build/build.properties @@ -0,0 +1,262 @@ +############################################################################### +# Copyright (c) 2003, 2009 IBM Corporation 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 +# +# Contributors: +# IBM Corporation - initial API and implementation +############################################################################### +##################### +# Parameters describing how and where to execute the build. +# Typical users need only update the following properties: +# baseLocation - where things you are building against are installed +# bootclasspath - The base jars to compile against (typicaly rt.jar) +# configs - the list of {os, ws, arch} configurations to build. +# +# Of course any of the settings here can be overridden by spec'ing +# them on the command line (e.g., -DbaseLocation=d:/eclipse + +#The type of the top level element we are building, generally "feature" +topLevelElementType = feature +#The id of the top level element we are building +topLevelElementId = org.yocto.doc + +############# PRODUCT/PACKAGING CONTROL ############# +product=/plugin or feature id/path/to/.product +runPackager=true + +#Set the name of the archive that will result from the product build. +#archiveNamePrefix= + +# The prefix that will be used in the generated archive. +archivePrefix=eclipse + +# The location underwhich all of the build output will be collected. +collectingFolder=${archivePrefix} + +# The list of {os, ws, arch} configurations to build. This +# value is a '&' separated list of ',' separate triples. For example, +# configs=win32,win32,x86 & linux,motif,x86 +# By default the value is *,*,* +configs = *, *, * +#configs=win32, win32, x86 & \ +# win32,win32,x86_64 & \ +# win32,win32,wpf & \ +# linux, gtk, ppc & \ +# linux, gtk, x86 & \ +# linux, gtk, x86_64 & \ +# linux, motif, x86 & \ +# solaris, motif, sparc & \ +# solaris, gtk, sparc & \ +# aix, motif, ppc & \ +# hpux, motif, ia64_32 & \ +# macosx, carbon, ppc & \ +# macosx, carbon, x86 & \ +# macosx, cocoa, ppc & \ +# macosx, cocoa, x86 & \ +# macosx, cocoa, x86_64 + +# By default PDE creates one archive (result) per entry listed in the configs property. +# Setting this value to true will cause PDE to only create one output containing all +# artifacts for all the platforms listed in the configs property. +# To control the output format for the group, add a "group, group, group - <format>" entry to the +# archivesFormat. +#groupConfigurations=true + +#The format of the archive. By default a zip is created using antZip. +#The list can only contain the configuration for which the desired format is different than zip. +#archivesFormat=win32, win32, x86 - antZip& \ +# linux, gtk, ppc - antZip &\ +# linux, gtk, x86 - antZip& \ +# linux, gtk, x86_64 - antZip& \ +# linux, motif, x86 - antZip& \ +# solaris, motif, sparc - antZip& \ +# solaris, gtk, sparc - antZip& \ +# aix, motif, ppc - antZip& \ +# hpux, motif, PA_RISC - antZip& \ +# macosx, carbon, ppc - antZip + +#Allow cycles involving at most one bundle that needs to be compiled with the rest being binary bundles. +allowBinaryCycles = true + +#Sort bundles depenedencies across all features instead of just within a given feature. +#flattenDependencies = true + +#Parallel compilation, requires flattenedDependencies=true +#parallelCompilation=true +#parallelThreadCount= +#parallelThreadsPerProcessor= + +#Set to true if you want the output to be ready for an update jar (no site.xml generated) +outputUpdateJars = true + +#Set to true for Jnlp generation +#codebase should be a URL that will be used as the root of all relative URLs in the output. +#generateJnlp=false +#jnlp.codebase=<codebase url> +#jnlp.j2se=<j2se version> +#jnlp.locale=<a locale> +#jnlp.generateOfflineAllowed=true or false generate <offlineAllowed/> attribute in the generated features +#jnlp.configs=${configs} #uncomment to filter the content of the generated jnlp files based on the configuration being built + +#Set to true if you want to sign jars +#signJars=false +#sign.alias=<alias> +#sign.keystore=<keystore location> +#sign.storepass=<keystore password> +#sign.keypass=<key password> + +#Arguments to send to the zip executable +zipargs= + +#Arguments to send to the tar executable +tarargs= + +#Control the creation of a file containing the version included in each configuration - on by default +#generateVersionsLists=false + +############## BUILD NAMING CONTROL ################ +# The directory into which the build elements are fetched and where +# the build takes place. +#buildDirectory= + +# Type of build. Used in naming the build output. Typically this value is +# one of I, N, M, S, ... +buildType=I + +# ID of the build. Used in naming the build output. +buildId=TestBuild + +# Label for the build. Used in naming the build output +buildLabel=${buildType}.${buildId} + +# Timestamp for the build. Used in naming the build output +timestamp=007 + +#The value to be used for the qualifier of a plugin or feature when you want to override the value computed by pde. +#The value will only be applied to plugin or features indicating build.properties, qualifier = context +#forceContextQualifier=<the value for the qualifier> + +#Enable / disable the generation of a suffix for the features that use .qualifier. +#The generated suffix is computed according to the content of the feature +#generateFeatureVersionSuffix=true + +############# BASE CONTROL ############# +# Settings for the base Eclipse components and Java class libraries +# against which you are building. +# Base location for anything the build needs to compile against. For example, +# in most RCP app or a plug-in, the baseLocation should be the location of a previously +# installed Eclipse against which the application or plug-in code will be compiled and the RCP delta pack. + +#base=<path/to/parent/of/eclipse> +#baseLocation=${base}/eclipse + +#Folder containing repositories whose content is needed to compile against +#repoBaseLocation=${base}/repos +#Folder where the content of the repositories from ${repoBaseLocation} will be made available as a form suitable to be compiled against +#transformedRepoLocation=${base}/transformedRepos + +#Os/Ws/Arch/nl of the eclipse specified by baseLocation +#baseos=win32 +#basews=win32 +#basearch=x86 + +#this property indicates whether you want the set of plug-ins and features to be considered during the build to be limited to the ones reachable from the features / plugins being built +filteredDependencyCheck=false + +#this property indicates whether the resolution should be done in development mode (i.e. ignore multiple bundles with singletons) +resolution.devMode=false + +#pluginPath is a list of locations in which to find plugins and features. This list is separated by the platform file separator (; or :) +#a location is one of: +#- the location of the jar or folder that is the plugin or feature : /path/to/foo.jar or /path/to/foo +#- a directory that contains a /plugins or /features subdirectory +#- the location of a feature.xml, or for 2.1 style plugins, the plugin.xml or fragment.xml +#pluginPath= + +skipBase=true +eclipseURL=<url for eclipse download site> +eclipseBuildId=<Id of Eclipse build to get> +eclipseBaseURL=${eclipseURL}/eclipse-platform-${eclipseBuildId}-win32.zip + + +############# MAP FILE CONTROL ################ +# This section defines CVS tags to use when fetching the map files from the repository. +# If you want to fetch the map file from repository / location, change the getMapFiles target in the customTargets.xml + +skipMaps=true +mapsRepo=:pserver:anonymous@example.com/path/to/repo +mapsRoot=path/to/maps +mapsCheckoutTag=HEAD + +#tagMaps=true +mapsTagTag=v${buildId} + + +############ REPOSITORY CONTROL ############### +# This section defines properties parameterizing the repositories where plugins, fragments +# bundles and features are being obtained from. + +# The tags to use when fetching elements to build. +# By default thebuilder will use whatever is in the maps. +# This value takes the form of a comma separated list of repository identifier (like used in the map files) and the +# overriding value +# For example fetchTag=CVS=HEAD, SVN=v20050101 +# fetchTag=HEAD +skipFetch=true + + +############# JAVA COMPILER OPTIONS ############## +# The location of the Java jars to compile against. Typically the rt.jar for your JDK/JRE +#bootclasspath=${java.home}/lib/rt.jar + +# specific JRE locations to compile against. These values are used to compile bundles specifying a +# Bundle-RequiredExecutionEnvironment. Uncomment and set values for environments that you support +#CDC-1.0/Foundation-1.0= /path/to/rt.jar +#CDC-1.1/Foundation-1.1= +#OSGi/Minimum-1.0= +#OSGi/Minimum-1.1= +#JRE-1.1= +#J2SE-1.2= +#J2SE-1.3= +#J2SE-1.4= +#J2SE-1.5= +#JavaSE-1.6= +#PersonalJava-1.1= +#PersonalJava-1.2= +#CDC-1.0/PersonalBasis-1.0= +#CDC-1.0/PersonalJava-1.0= +#CDC-1.1/PersonalBasis-1.1= +#CDC-1.1/PersonalJava-1.1= + +# Specify the output format of the compiler log when eclipse jdt is used +logExtension=.log + +# Whether or not to include debug info in the output jars +javacDebugInfo=false + +# Whether or not to fail the build if there are compiler errors +javacFailOnError=true + +# Enable or disable verbose mode of the compiler +javacVerbose=true + +# Extra arguments for the compiler. These are specific to the java compiler being used. +#compilerArg= + +# Default value for the version of the source code. This value is used when compiling plug-ins that do not set the Bundle-RequiredExecutionEnvironment or set javacSource in build.properties +javacSource=1.6 + +# Default value for the version of the byte code targeted. This value is used when compiling plug-ins that do not set the Bundle-RequiredExecutionEnvironment or set javacTarget in build.properties. +javacTarget=1.6 + +#individualSourceBundles=true + +#p2.gathering=true +p2.compress=true +#p2.category.site=file:${buildDirectory}/site.xml +p2.category.definition=file:${buildDirectory}/category.xml +p2.metadata.repo.name=Yocto Project Update Site +p2.artifact.repo.name=Yocto Project Update Site diff --git a/features/org.yocto.doc.headless.build/customTargets.xml b/features/org.yocto.doc.headless.build/customTargets.xml new file mode 100644 index 0000000..8cb505e --- /dev/null +++ b/features/org.yocto.doc.headless.build/customTargets.xml @@ -0,0 +1,212 @@ +<project name="Build specific targets and properties" default="noDefault"> + + <!-- ===================================================================== --> + <!-- Run a given ${target} on all elements being built --> + <!-- Add on <ant> task for each top level element being built. --> + <!-- ===================================================================== --> + <available property="allElementsFile" file="${builder}/allElements.xml" value="${builder}/allElements.xml"/> + <property name="allElementsFile" location="${eclipse.pdebuild.templates}/headless-build/allElements.xml"/> + + <import file="${allElementsFile}" /> + <target name="allElements"> + <antcall target="allElementsDelegator" /> + </target> + + <!-- ===================================================================== --> + <!-- ===================================================================== --> + <target name="getBaseComponents" depends="checkLocalBase" unless="skipBase"> + <get src="${eclipseBaseURL}" dest="${buildDirectory}/../temp-base.zip" /> + <unzip dest="${base}" overwrite="true" src="${buildDirectory}/../temp-base.zip" /> + </target> + + <target name="checkLocalBase"> + <available file="${base}" property="skipBase" /> + </target> + + <!-- ===================================================================== --> + <!-- Check out map files from correct repository --> + <!-- Replace values for mapsCheckoutTag as desired. --> + <!-- ===================================================================== --> + <target name="getMapFiles" depends="checkLocalMaps" unless="skipMaps"> + <property name="mapsCheckoutTag" value="HEAD" /> + <cvs cvsRoot="${mapsRepo}" package="${mapsRoot}" dest="${buildDirectory}/maps" tag="${mapsCheckoutTag}" /> + </target> + + <target name="checkLocalMaps"> + <available property="skipMaps" file="${buildDirectory}/maps" /> + </target> + + <target name="tagMapFiles" if="tagMaps"> + <cvs dest="${buildDirectory}/maps/${mapsRoot}" command="tag ${mapsTagTag}" /> + </target> + + <!-- ===================================================================== --> + + <target name="clean" unless="noclean"> + <antcall target="allElements"> + <param name="target" value="cleanElement" /> + </antcall> + </target> + + <target name="gatherLogs"> + <mkdir dir="${buildDirectory}/${buildLabel}/compilelogs" /> + <antcall target="allElements"> + <param name="target" value="gatherLogs" /> + </antcall> + <unzip dest="${buildDirectory}/${buildLabel}/compilelogs" overwrite="true"> + <fileset dir="${buildDirectory}/features"> + <include name="**/*.log.zip" /> + </fileset> + </unzip> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do before setup --> + <!-- ===================================================================== --> + <target name="preSetup"> + <delete dir="${buildDirectory}/plugins"/> + <mkdir dir="${buildDirectory}/plugins"/> + <copy todir="${buildDirectory}/plugins" failonerror="true"> + <fileset dir="${otherSrcDirectory}/plugins"/> + </copy> + <delete dir="${buildDirectory}/features"/> + <copy todir="${buildDirectory}/features" failonerror="true" > + <fileset dir="${otherSrcDirectory}/features"/> + </copy> + <antcall target="prepareForP2" /> + </target> + + <target name="prepareForP2" if="p2.gathering"> + <copy file="${otherSrcDirectory}/features/org.yocto.sdk.site/site.xml" todir="${buildDirectory}" /> + <copy file="${otherSrcDirectory}/features/org.yocto.sdk.site/category.xml" todir="${buildDirectory}" /> + <xmlproperty file="${otherSrcDirectory}/features/org.yocto.doc/feature.xml" /> + <replace file="${buildDirectory}/category.xml"> + <replacefilter token="@docFeatureVersion@" value="${feature(version)}"/> + </replace> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after setup but before starting the build proper --> + <!-- ===================================================================== --> + <target name="postSetup"> + <antcall target="getBaseComponents" /> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do before fetching the build elements --> + <!-- ===================================================================== --> + <target name="preFetch"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after fetching the build elements --> + <!-- ===================================================================== --> + <target name="postFetch"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do before the repositories are being processed --> + <!-- ===================================================================== --> + <target name="preProcessRepos"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after the repositories have been processed --> + <!-- ===================================================================== --> + <target name="postProcessRepos"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do before generating the build scripts. --> + <!-- ===================================================================== --> + <target name="preGenerate"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after generating the build scripts. --> + <!-- ===================================================================== --> + <target name="postGenerate"> + <antcall target="clean" /> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do before running the build.xmls for the elements being built. --> + <!-- ===================================================================== --> + <target name="preProcess"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after running the build.xmls for the elements being built. --> + <!-- ===================================================================== --> + <target name="postProcess"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do before running assemble. --> + <!-- ===================================================================== --> + <target name="preAssemble"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after running assemble. --> + <!-- ===================================================================== --> + <target name="postAssemble"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do before running package. --> + <!-- ===================================================================== --> + <target name="prePackage"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after running package. --> + <!-- ===================================================================== --> + <target name="postPackage"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do after the build is done. --> + <!-- ===================================================================== --> + <target name="postBuild"> + <antcall target="gatherLogs" /> + <antcall target="updateSiteContent" /> + </target> + + <target name="updateSiteContent" if="p2.gathering"> + <property file="${buildDirectory}/finalFeaturesVersions.properties" /> + <copy file="${otherSrcDirectory}/features/org.yocto.sdk.site/site.xml" todir="${buildDirectory}" /> + <replace file="${buildDirectory}/site.xml"> + <replacefilter token="@docGenVersion@" value="${org.yocto.doc}"/> + </replace> + <zip destfile="${buildDirectory}/${buildLabel}/org.yocto.doc-${buildId}-group.group.group.zip" update="true"> + <zipfileset dir="${buildDirectory}"> + <include name="site.xml"/> + </zipfileset> + <zipfileset dir="${otherSrcDirectory}/features/org.yocto.sdk.site"> + <include name="index.html"/> + </zipfileset> + <zipfileset dir="${otherSrcDirectory}/features/org.yocto.sdk.site/web" prefix="web"/> + </zip> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do to test the build results --> + <!-- ===================================================================== --> + <target name="test"> + </target> + + <!-- ===================================================================== --> + <!-- Steps to do to publish the build results --> + <!-- ===================================================================== --> + <target name="publish"> + </target> + + <!-- ===================================================================== --> + <!-- Default target --> + <!-- ===================================================================== --> + <target name="noDefault"> + <echo message="You must specify a target when invoking this file" /> + </target> + +</project> -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 07/12] features/sdk.site: Added yocto.doc feature to update site 2013-02-08 13:24 ` [RFC v5 06/12] features/doc.headless.build: Added headless build for yocto.doc feature Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 08/12] scripts/build.sh: Added yocto.doc feature to build Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- features/org.yocto.sdk.site/category.xml | 4 ++++ features/org.yocto.sdk.site/site.xml | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/features/org.yocto.sdk.site/category.xml b/features/org.yocto.sdk.site/category.xml index 6466ea5..4dd0178 100644 --- a/features/org.yocto.sdk.site/category.xml +++ b/features/org.yocto.sdk.site/category.xml @@ -9,6 +9,10 @@ <feature url="features/org.yocto.bc_@bcfeatureVersion@.jar" id="org.yocto.bc" version="@bcfeatureVersion@"> <category name="Yocto Project Bitbake Commander"/> </feature> + <feature url="features/org.yocto.doc_@docFeatureVersion@.jar" 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> diff --git a/features/org.yocto.sdk.site/site.xml b/features/org.yocto.sdk.site/site.xml index d477279..33f36cd 100644 --- a/features/org.yocto.sdk.site/site.xml +++ b/features/org.yocto.sdk.site/site.xml @@ -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_@docGenVersion@.jar" 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> -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 08/12] scripts/build.sh: Added yocto.doc feature to build 2013-02-08 13:24 ` [RFC v5 07/12] features/sdk.site: Added yocto.doc feature to update site Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 09/12] scripts/generate-doc.sh: Add script to handle eclipse help generation Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- scripts/build.sh | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/scripts/build.sh b/scripts/build.sh index e1ec5fc..73bf889 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -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 -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 09/12] scripts/generate-doc.sh: Add script to handle eclipse help generation 2013-02-08 13:24 ` [RFC v5 08/12] scripts/build.sh: Added yocto.doc feature to build Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 10/12] plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> 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. Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- scripts/generate-doc.sh | 85 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100755 scripts/generate-doc.sh diff --git a/scripts/generate-doc.sh b/scripts/generate-doc.sh new file mode 100755 index 0000000..7152d6f --- /dev/null +++ b/scripts/generate-doc.sh @@ -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} -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 10/12] plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents 2013-02-08 13:24 ` [RFC v5 09/12] scripts/generate-doc.sh: Add script to handle eclipse help generation Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 11/12] scripts/generate-doc.sh: Copy generated eclipse help into the user.doc plugin Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> The separate yocto manuals are added to the table of contents to prepare their inclusion into the plugin. Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- plugins/org.yocto.doc.user/plugin.xml | 28 ++++++++++++++++++++++++++++ plugins/org.yocto.doc.user/toc.xml | 21 +++++++++++++++++++++ 2 files changed, 49 insertions(+) diff --git a/plugins/org.yocto.doc.user/plugin.xml b/plugins/org.yocto.doc.user/plugin.xml index 8353cd1..8e87ce7 100644 --- a/plugins/org.yocto.doc.user/plugin.xml +++ b/plugins/org.yocto.doc.user/plugin.xml @@ -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> diff --git a/plugins/org.yocto.doc.user/toc.xml b/plugins/org.yocto.doc.user/toc.xml index 4998ef3..86fbe29 100644 --- a/plugins/org.yocto.doc.user/toc.xml +++ b/plugins/org.yocto.doc.user/toc.xml @@ -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> -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 11/12] scripts/generate-doc.sh: Copy generated eclipse help into the user.doc plugin 2013-02-08 13:24 ` [RFC v5 10/12] plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 2013-02-08 13:24 ` [RFC v5 12/12] scripts/build.sh: Add documentation generation to the default build Timo Mueller 0 siblings, 1 reply; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> After successful generation the eclipse help files and the table of contents of each manual are copied to the user.doc plugin. Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- scripts/generate-doc.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/generate-doc.sh b/scripts/generate-doc.sh index 7152d6f..588638c 100755 --- a/scripts/generate-doc.sh +++ b/scripts/generate-doc.sh @@ -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 -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* [RFC v5 12/12] scripts/build.sh: Add documentation generation to the default build 2013-02-08 13:24 ` [RFC v5 11/12] scripts/generate-doc.sh: Copy generated eclipse help into the user.doc plugin Timo Mueller @ 2013-02-08 13:24 ` Timo Mueller 0 siblings, 0 replies; 14+ messages in thread From: Timo Mueller @ 2013-02-08 13:24 UTC (permalink / raw) To: yocto; +Cc: Timo Mueller From: Timo Mueller <timo.mueller@bmw-carit.de> When building the plugin the matching documentation is automatically generated and added to the user.doc plugin prior to the plugin build. Signed-off-by: Timo Mueller <timo.mueller@bmw-carit.de> --- scripts/build.sh | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/scripts/build.sh b/scripts/build.sh index 73bf889..a1b420c 100755 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -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" -- 1.7.11.7 ^ permalink raw reply related [flat|nested] 14+ messages in thread
* Re: [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse 2013-02-08 13:24 [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse Timo Mueller 2013-02-08 13:24 ` [RFC v5 01/12] features/sdk.site: Fixed typo in category name Timo Mueller @ 2013-02-08 21:03 ` Zhang, Jessica 1 sibling, 0 replies; 14+ messages in thread From: Zhang, Jessica @ 2013-02-08 21:03 UTC (permalink / raw) To: Timo Mueller, yocto; +Cc: Timo Mueller 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 Signed-off-by: Jessica Zhang <jessica.zhang@intel.com> Diffstat -rwxr-xr-x scripts/generate-doc.sh 3 1 files changed, 1 insertions, 2 deletions diff --git a/scripts/generate-doc.sh b/scripts/generate-doc.sh index 588638c..d645e54 100755 --- a/scripts/generate-doc.sh +++ b/scripts/generate-doc.sh @@ -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: yocto-bounces@yoctoproject.org [mailto:yocto-bounces@yoctoproject.org] On Behalf Of Timo Mueller Sent: Friday, February 08, 2013 5:25 AM To: yocto@yoctoproject.org Cc: Timo Mueller Subject: [yocto] [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse From: Timo Mueller <timo.mueller@bmw-carit.de> 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 yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto ^ permalink raw reply related [flat|nested] 14+ messages in thread
end of thread, other threads:[~2013-02-08 21:03 UTC | newest] Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2013-02-08 13:24 [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse Timo Mueller 2013-02-08 13:24 ` [RFC v5 01/12] features/sdk.site: Fixed typo in category name Timo Mueller 2013-02-08 13:24 ` [RFC v5 02/12] Fixed typo in version variable name Timo Mueller 2013-02-08 13:24 ` [RFC v5 03/12] plugins/sdk.ide.doc.user: Add empty eclipse help Timo Mueller 2013-02-08 13:24 ` [RFC v5 04/12] plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation Timo Mueller 2013-02-08 13:24 ` [RFC v5 05/12] features/org.yocto.doc: Add new feature containing yocto project documentation Timo Mueller 2013-02-08 13:24 ` [RFC v5 06/12] features/doc.headless.build: Added headless build for yocto.doc feature Timo Mueller 2013-02-08 13:24 ` [RFC v5 07/12] features/sdk.site: Added yocto.doc feature to update site Timo Mueller 2013-02-08 13:24 ` [RFC v5 08/12] scripts/build.sh: Added yocto.doc feature to build Timo Mueller 2013-02-08 13:24 ` [RFC v5 09/12] scripts/generate-doc.sh: Add script to handle eclipse help generation Timo Mueller 2013-02-08 13:24 ` [RFC v5 10/12] plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents Timo Mueller 2013-02-08 13:24 ` [RFC v5 11/12] scripts/generate-doc.sh: Copy generated eclipse help into the user.doc plugin Timo Mueller 2013-02-08 13:24 ` [RFC v5 12/12] scripts/build.sh: Add documentation generation to the default build Timo Mueller 2013-02-08 21:03 ` [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse Zhang, Jessica
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.