Integrate yocto documentation into eclipse
cover Integrate yocto documentation into eclipse
From: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers,
Timo
Timo Mueller (8):
plugins/sdk.doc.user: Added plugin for the yocto project
documentation
plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual
features/org.yocto.sdk.doc/.project | 17 + features/org.yocto.sdk.doc/build.properties | 5 + features/org.yocto.sdk.doc/feature.properties | 208 ++++++ features/org.yocto.sdk.doc/feature.xml | 40 ++ features/org.yocto.sdk.doc/license.html | 237 +++++++ .../sourceTemplateFeature/feature.properties | 208 ++++++ .../sourceTemplateFeature/license.html | 237 +++++++ features/org.yocto.sdk.site/category.xml | 6 + features/org.yocto.sdk.site/site.xml | 3 + features/org.yocto.sdk/feature.xml | 5 + plugins/org.yocto.sdk.doc.user/.classpath | 6 + plugins/org.yocto.sdk.doc.user/.project | 28 + .../.settings/org.eclipse.jdt.core.prefs | 8 + .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF | 8 + .../OSGI-INF/l10n/bundle.properties | 3 + plugins/org.yocto.sdk.doc.user/about.html | 82 +++ plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml | 61 ++ plugins/org.yocto.sdk.doc.user/build.properties | 14 + .../html/adt-manual/ch01.html | 90 +++ .../html/adt-manual/ch01s02.html | 166 +++++ .../html/adt-manual/ch02.html | 450 +++++++++++++ .../html/adt-manual/ch02s02.html | 56 ++ .../html/adt-manual/ch02s03.html | 182 ++++++ .../html/adt-manual/ch03.html | 97 +++ .../html/adt-manual/ch03s02.html | 78 +++ .../html/adt-manual/ch04.html | 675 ++++++++++++++++++++ .../html/adt-manual/ch04s02.html | 94 +++ .../html/adt-manual/ch04s03.html | 77 +++ .../html/adt-manual/ch04s04.html | 37 ++ .../html/adt-manual/ch04s05.html | 65 ++ .../html/adt-manual/ch04s06.html | 100 +++ .../html/adt-manual/ch04s07.html | 161 +++++ .../html/adt-manual/ch04s08.html | 184 ++++++ .../html/adt-manual/ch05.html | 112 ++++ .../html/adt-manual/ch05s02.html | 41 ++ .../html/adt-manual/index.html | 260 ++++++++ plugins/org.yocto.sdk.doc.user/html/book.css | 1 + .../yocto-project-qs/figures/building-an-image.png | Bin 0 -> 14891 bytes .../figures/using-a-pre-built-image.png | Bin 0 -> 12733 bytes .../yocto-project-qs/figures/yocto-environment.png | Bin 0 -> 73095 bytes .../figures/yocto-project-transp.png | Bin 0 -> 8626 bytes .../html/yocto-project-qs/index.html | 542 ++++++++++++++++ plugins/org.yocto.sdk.doc.user/plugin.xml | 19 + plugins/org.yocto.sdk.doc.user/toc.xml | 9 + .../yocto-project-qs-toc.xml | 32 + 45 files changed, 4704 insertions(+), 0 deletions(-) create mode 100644 features/org.yocto.sdk.doc/.project create mode 100644 features/org.yocto.sdk.doc/build.properties create mode 100644 features/org.yocto.sdk.doc/feature.properties create mode 100644 features/org.yocto.sdk.doc/feature.xml create mode 100644 features/org.yocto.sdk.doc/license.html create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/license.html create mode 100644 plugins/org.yocto.sdk.doc.user/.classpath create mode 100644 plugins/org.yocto.sdk.doc.user/.project create mode 100644 plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs create mode 100644 plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.sdk.doc.user/about.html create mode 100644 plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/build.properties create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s06.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s07.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s08.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/book.css create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/building-an-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/using-a-pre-built-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-environment.png create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-project-transp.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/plugin.xml create mode 100644 plugins/org.yocto.sdk.doc.user/toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/yocto-project-qs-toc.xml
Signature · 1 line
1.7.7.6
RFC 1/8 plugins/sdk.doc.user: Added plugin for the yocto project documentation
From: Timo Mueller <[email protected]>
This currently empty plugin will in the future contain the documentation of the yocto project converted to the eclipse help format.
--- plugins/org.yocto.sdk.doc.user/.classpath | 6 ++++ plugins/org.yocto.sdk.doc.user/.project | 28 ++++++++++++++++++++ .../.settings/org.eclipse.jdt.core.prefs | 8 +++++ .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF | 7 +++++ .../OSGI-INF/l10n/bundle.properties | 3 ++ plugins/org.yocto.sdk.doc.user/build.properties | 4 +++ plugins/org.yocto.sdk.doc.user/plugin.xml | 4 +++ 7 files changed, 60 insertions(+), 0 deletions(-) create mode 100644 plugins/org.yocto.sdk.doc.user/.classpath create mode 100644 plugins/org.yocto.sdk.doc.user/.project create mode 100644 plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs create mode 100644 plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.sdk.doc.user/build.properties create mode 100644 plugins/org.yocto.sdk.doc.user/plugin.xml
plugins/org.yocto.sdk.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.6"/> + <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> + <classpathentry kind="output" path="bin"/> +</classpath>
plugins/org.yocto.sdk.doc.user/.project new file +28 -0
@@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.yocto.sdk.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.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs new file +8 -0
@@ -0,0 +1,8 @@ +#Fri Mar 04 13:59:33 CET 2011 +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6 +org.eclipse.jdt.core.compiler.compliance=1.6 +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.source=1.6
plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF new file +7 -0
@@ -0,0 +1,7 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %plugin.name +Bundle-SymbolicName: org.yocto.sdk.doc.user;singleton:=true +Bundle-Version: 1.2.0.qualifier +Bundle-Vendor: %plugin.provider +Bundle-RequiredExecutionEnvironment: JavaSE-1.6
plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties new file +3 -0
@@ -0,0 +1,3 @@ +#Properties file for org.yocto.sdk.doc.user +Bundle-Vendor = yoctoproject.org +Bundle-Name = Yocto Project Documentation
plugins/org.yocto.sdk.doc.user/build.properties new file +4 -0
@@ -0,0 +1,4 @@ +bin.includes = plugin.xml,\ + .,\ + META-INF/,\ + OSGI-INF/
plugins/org.yocto.sdk.doc.user/plugin.xml new file +4 -0
@@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?eclipse version="3.4"?> +<plugin> +</plugin>
Signature · 1 line
1.7.7.6
RFC 2/8 plugins/sdk.doc.user: Added empty table of contents
From: Timo Mueller <[email protected]>
This is the preparation needed for adding documentation from the yocto project later on.
--- .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF | 1 + plugins/org.yocto.sdk.doc.user/build.properties | 2 ++ plugins/org.yocto.sdk.doc.user/plugin.xml | 7 +++++++ plugins/org.yocto.sdk.doc.user/toc.xml | 3 +++ 4 files changed, 13 insertions(+), 0 deletions(-) create mode 100644 plugins/org.yocto.sdk.doc.user/toc.xml
plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF +1 -0
@@ -5,3 +5,4 @@ Bundle-SymbolicName: org.yocto.sdk.doc.user;singleton:=true Bundle-Version: 1.2.0.qualifier Bundle-Vendor: %plugin.provider Bundle-RequiredExecutionEnvironment: JavaSE-1.6 +Require-Bundle: org.eclipse.help
plugins/org.yocto.sdk.doc.user/build.properties +2 -0
@@ -1,4 +1,6 @@ bin.includes = plugin.xml,\ .,\ META-INF/,\ + toc.xml,\ OSGI-INF/ +src.includes = toc.xml
plugins/org.yocto.sdk.doc.user/plugin.xml +7 -0
@@ -1,4 +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.sdk.doc.user/toc.xml new file +3 -0
@@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="UTF-8"?> +<toc label="The Yocto Project Documentation"> +</toc>
Signature · 1 line
1.7.7.6
RFC 3/8 feature/sdk.doc: Added feature containing yocto documentation plugins
From: Timo Mueller <[email protected]>
The project documentation of yocto is licensed under the Create Commons Attribution Share Alike 2.0 (CCA-SA). Because the plugins containing this documentation cannot be licensed under the Eclipse Public License 1.0, as it is not compatible to the CCA-SA, this feature will contain all plugins licensed by the CCA-SA.
The idea is to cleanly separate content licensed by the different licenses.
--- features/org.yocto.sdk.doc/.project | 17 ++ features/org.yocto.sdk.doc/build.properties | 5 + features/org.yocto.sdk.doc/feature.properties | 208 +++++++++++++++++ features/org.yocto.sdk.doc/feature.xml | 32 +++ features/org.yocto.sdk.doc/license.html | 237 ++++++++++++++++++++ .../sourceTemplateFeature/feature.properties | 208 +++++++++++++++++ .../sourceTemplateFeature/license.html | 237 ++++++++++++++++++++ 7 files changed, 944 insertions(+), 0 deletions(-) create mode 100644 features/org.yocto.sdk.doc/.project create mode 100644 features/org.yocto.sdk.doc/build.properties create mode 100644 features/org.yocto.sdk.doc/feature.properties create mode 100644 features/org.yocto.sdk.doc/feature.xml create mode 100644 features/org.yocto.sdk.doc/license.html create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/license.html
features/org.yocto.sdk.doc/.project new file +17 -0
@@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.yocto.sdk.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.sdk.doc/build.properties new file +5 -0
@@ -0,0 +1,5 @@ +bin.includes = feature.xml,\ + feature.properties,\ + license.html + [email protected]=org.yocto.sdk.doc
features/org.yocto.sdk.doc/feature.properties new file +208 -0
208 lines not on this page · raw message
features/org.yocto.sdk.doc/feature.xml new file +32 -0
@@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<feature + id="org.yocto.sdk.doc" + label="%featureName" + version="1.2.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> + + <includes + id="org.yocto.sdk.doc.source" + version="0.0.0"/> + + <requires> + <import plugin="org.eclipse.ui.cheatsheets"/> + <import plugin="org.eclipse.help"/> + </requires> +</feature>
features/org.yocto.sdk.doc/license.html new file +237 -0
237 lines not on this page · raw message
features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties new file +208 -0
208 lines not on this page · raw message
features/org.yocto.sdk.doc/sourceTemplateFeature/license.html new file +237 -0
237 lines not on this page · raw message
Signature · 1 line
1.7.7.6
RFC 4/8 feature/sdk.doc: Added org.yocto.sdk.doc.user plugin
From: Timo Mueller <[email protected]>
The added plugin will contain the official documentation of the yocto project.
--- features/org.yocto.sdk.doc/feature.xml | 8 ++++++++ 1 files changed, 8 insertions(+), 0 deletions(-)
features/org.yocto.sdk.doc/feature.xml +8 -0
@@ -29,4 +29,12 @@ <import plugin="org.eclipse.ui.cheatsheets"/> <import plugin="org.eclipse.help"/> </requires> + + <plugin + id="org.yocto.sdk.doc.user" + download-size="0" + install-size="0" + version="0.0.0" + unpack="false"/> + </feature>
Signature · 1 line
1.7.7.6
RFC 5/8 plugins/sdk.doc.user: Added yocto quick start guide
From: Timo Mueller <[email protected]>
The Yocto Project Quick Start Guide is integrated into the eclipse help. This includes the generated html files as well as a table of contents that is needed by the eclipse help center to allow the user to navigate the contents.
Source: git://git.yoctoproject.org/yocto-docs/
--- plugins/org.yocto.sdk.doc.user/about.html | 58 +++ plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml | 61 +++ plugins/org.yocto.sdk.doc.user/build.properties | 8 +- plugins/org.yocto.sdk.doc.user/html/book.css | 1 + .../yocto-project-qs/figures/building-an-image.png | Bin 0 -> 14891 bytes .../figures/using-a-pre-built-image.png | Bin 0 -> 12733 bytes .../yocto-project-qs/figures/yocto-environment.png | Bin 0 -> 73095 bytes .../figures/yocto-project-transp.png | Bin 0 -> 8626 bytes .../html/yocto-project-qs/index.html | 542 ++++++++++++++++++++ plugins/org.yocto.sdk.doc.user/plugin.xml | 4 + plugins/org.yocto.sdk.doc.user/toc.xml | 3 + 11 files changed, 676 insertions(+), 1 deletions(-) create mode 100644 plugins/org.yocto.sdk.doc.user/about.html create mode 100644 plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/html/book.css create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/building-an-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/using-a-pre-built-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-environment.png create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-project-transp.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/index.html
plugins/org.yocto.sdk.doc.user/about.html new file +58 -0
@@ -0,0 +1,58 @@ + +<!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>July 3, 2012</em> + </p> + <h3>License</h3> + + <p> + Copyright (c) 2010 Intel, Inc. and others. <br /> + All rights reserved. This program and the accompanying materials + are made available under the terms of the Creative Commons Attribution-Share + Alike 2.0 UK: England & Wales which accompanies this distribution, + and is available at <br /> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </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> 980b4d22dab4ac681c6dc1a85e78306213799062 + </p> +</body> +</html> +
plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml new file +61 -0
61 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/build.properties +7 -1
@@ -1,6 +1,12 @@ bin.includes = plugin.xml,\ .,\ META-INF/,\ + html/,\ toc.xml,\ + yocto-project-qs-toc.xml,\ + about.html,\ OSGI-INF/ -src.includes = toc.xml +src.includes = toc.xml, \ + html/,\ + yocto-project-qs-toc.xml,\ + about.html
plugins/org.yocto.sdk.doc.user/html/book.css new file +1 -0
@@ -0,0 +1 @@ +@import "PLUGINS_ROOT/PRODUCT_PLUGIN/book.css";
plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/building-an-image.png new file binary +0 -0
plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/using-a-pre-built-image.png new file binary +0 -0
plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-environment.png new file binary +0 -0
plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-project-transp.png new file binary +0 -0
plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/index.html new file +542 -0
542 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/plugin.xml +4 -0
@@ -7,5 +7,9 @@ file="toc.xml" primary="true"> </toc> + <toc + file="yocto-project-qs-toc.xml" + primary="false"> + </toc> </extension> </plugin>
plugins/org.yocto.sdk.doc.user/toc.xml +3 -0
@@ -1,3 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <toc label="The Yocto Project Documentation"> + <topic label="The Yocto Project Quick Start"> + <link toc="yocto-project-qs-toc.xml"/> + </topic> </toc>
Signature · 1 line
1.7.7.6
RFC 6/8 feature/sdk: Added org.yocto.sdk.doc feature.
From: Timo Mueller <[email protected]>
The feature is added to the yocto main feature so it will be part of the build. Also when installing the documentation feature will also be installed.
To be able to install the documentation feature is has to be available via an eclipse update site. It is currently not part of the official yocto update site. Therefor the feature has to be installed manually until it is part of the yocto update site.
--- features/org.yocto.sdk/feature.xml | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-)
features/org.yocto.sdk/feature.xml +5 -0
@@ -8,6 +8,7 @@ Contributors: Intel - initial API and implementation + BMW Car IT GmbH - added yocto documentation feature --> <feature id="org.yocto.sdk"
@@ -34,6 +35,10 @@ <includes id="org.yocto.sdk.source"/> + <includes + id="org.yocto.sdk.doc" + version="0.0.0"/> + <requires> <import plugin="org.eclipse.core.runtime"/> <import plugin="org.eclipse.osgi"/>
Signature · 1 line
1.7.7.6
RFC 7/8 features/sdk.site: Added eclipse help feature to update site
From: Timo Mueller <[email protected]>
Using the update site the user is able to install the documentation feature. As it is required by yocto's main feature it will be automatically installed during the main features installation.
--- features/org.yocto.sdk.site/category.xml | 6 ++++++ features/org.yocto.sdk.site/site.xml | 3 +++ 2 files changed, 9 insertions(+), 0 deletions(-)
features/org.yocto.sdk.site/category.xml +6 -0
@@ -6,5 +6,11 @@ <feature url="features/org.yocto.sdk.source_@[email protected]" id="org.yocto.sdk.source" version="@featureVerion@"> <category name="Yocto SDK"/> </feature> + <feature url="features/org.yocto.sdk.doc_@[email protected]" id="org.yocto.sdk.doc" version="@featureVerion@"> + <category name="Yocto SDK"/> + </feature> + <feature url="features/org.yocto.sdk.doc.source_@[email protected]" id="org.yocto.sdk.doc.source" version="@featureVerion@"> + <category name="Yocto SDK"/> + </feature> <category-def name="Yocto SDK" label="Development tools & SDKs for Yocto Linux"/> </site>
features/org.yocto.sdk.site/site.xml +3 -0
@@ -6,5 +6,8 @@ <feature url="features/org.yocto.sdk_@[email protected]" id="org.yocto.sdk" version="@genVerion@"> <category name="Yocto SDK"/> </feature> + <feature url="features/org.yocto.sdk.doc_@[email protected]" id="org.yocto.sdk.doc" version="@genVerion@"> + <category name="Yocto SDK"/> + </feature> <category-def name="Yocto SDK" label="Development tools & SDKs for Yocto Linux"/> </site>
Signature · 1 line
1.7.7.6
RFC 8/8 plugins/sdk.doc.user: Added yocto adt manual
From: Timo Mueller <[email protected]>
The Yocto Project Application Development Toolkit (ADT) User's Guide is integrated into the eclipse help. This includes the generated html files as well as a table of contents that is needed by the eclipse help center to allow the user to navigate the contents.
Source: git://git.yoctoproject.org/yocto-docs/
--- plugins/org.yocto.sdk.doc.user/about.html | 24 + plugins/org.yocto.sdk.doc.user/build.properties | 4 +- .../html/adt-manual/ch01.html | 90 +++ .../html/adt-manual/ch01s02.html | 166 +++++ .../html/adt-manual/ch02.html | 450 +++++++++++++ .../html/adt-manual/ch02s02.html | 56 ++ .../html/adt-manual/ch02s03.html | 182 ++++++ .../html/adt-manual/ch03.html | 97 +++ .../html/adt-manual/ch03s02.html | 78 +++ .../html/adt-manual/ch04.html | 675 ++++++++++++++++++++ .../html/adt-manual/ch04s02.html | 94 +++ .../html/adt-manual/ch04s03.html | 77 +++ .../html/adt-manual/ch04s04.html | 37 ++ .../html/adt-manual/ch04s05.html | 65 ++ .../html/adt-manual/ch04s06.html | 100 +++ .../html/adt-manual/ch04s07.html | 161 +++++ .../html/adt-manual/ch04s08.html | 184 ++++++ .../html/adt-manual/ch05.html | 112 ++++ .../html/adt-manual/ch05s02.html | 41 ++ .../html/adt-manual/index.html | 260 ++++++++ plugins/org.yocto.sdk.doc.user/plugin.xml | 4 + plugins/org.yocto.sdk.doc.user/toc.xml | 3 + .../yocto-project-qs-toc.xml | 32 + 23 files changed, 2991 insertions(+), 1 deletions(-) create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s06.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s07.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s08.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/yocto-project-qs-toc.xml
plugins/org.yocto.sdk.doc.user/about.html +24 -0
@@ -52,6 +52,30 @@ </a> <br /> <em>Commit:</em> 980b4d22dab4ac681c6dc1a85e78306213799062 + <br /> + <br /> + <strong> + The Yocto Project Application Development Toolkit (ADT) User's Guide: + </strong> + <br /> + <br /> + This Manual provides an overview of the development process for images + and user-space applications. The manual provides plenty of information + for the user new to open-source development and the Yocto Project + build system. + <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> 980b4d22dab4ac681c6dc1a85e78306213799062 </p> </body> </html>
plugins/org.yocto.sdk.doc.user/build.properties +3 -1
@@ -5,8 +5,10 @@ bin.includes = plugin.xml,\ toc.xml,\ yocto-project-qs-toc.xml,\ about.html,\ + adt-manual-toc.xml,\ OSGI-INF/ src.includes = toc.xml, \ html/,\ yocto-project-qs-toc.xml,\ - about.html + about.html,\ + adt-manual-toc.xml
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01.html new file +90 -0
90 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01s02.html new file +166 -0
166 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02.html new file +450 -0
450 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s02.html new file +56 -0
56 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s03.html new file +182 -0
182 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03.html new file +97 -0
97 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03s02.html new file +78 -0
78 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04.html new file +675 -0
675 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s02.html new file +94 -0
94 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s03.html new file +77 -0
77 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s04.html new file +37 -0
@@ -0,0 +1,37 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta name="generator" content= +"HTML Tidy for Linux (vers 25 March 2009), see www.w3.org"> +<meta http-equiv="Content-Type" content= +"text/html; charset=us-ascii"> +<title>4.4. Building the Project</title> +<link rel="stylesheet" type="text/css" href="../book.css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title= +"The Yocto Project Application Development Toolkit (ADT) User's Guide."> +<link rel="up" href="ch04.html" title= +"Chapter 4. Working Within Eclipse"> +<link rel="prev" href="ch04s03.html" title= +"4.3. Configuring the Cross-Toolchains"> +<link rel="next" href="ch04s05.html" title= +"4.5. Starting QEMU in User Space NFS Mode"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" +alink="#0000FF"> +<div class="section" title="4.4. Building the Project"> +<div class="titlepage"> +<div> +<div> +<h2 class="title" style="clear: both"><a name= +"building-the-project" id= +"building-the-project"></a>4.4. Building the Project</h2> +</div> +</div> +</div> +<p>To build the project, select <code class="filename">Project +-> Build Project</code>. The console should update and you can +note the cross-compiler you are using.</p> +</div> +</body> +</html>
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s05.html new file +65 -0
65 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s06.html new file +100 -0
100 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s07.html new file +161 -0
161 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s08.html new file +184 -0
184 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05.html new file +112 -0
112 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05s02.html new file +41 -0
41 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/html/adt-manual/index.html new file +260 -0
260 lines not on this page · raw message
plugins/org.yocto.sdk.doc.user/plugin.xml +4 -0
@@ -8,6 +8,10 @@ primary="true"> </toc> <toc + file="adt-manual-toc.xml" + primary="false"> + </toc> + <toc file="yocto-project-qs-toc.xml" primary="false"> </toc>
plugins/org.yocto.sdk.doc.user/toc.xml +3 -0
@@ -3,4 +3,7 @@ <topic label="The Yocto Project Quick Start"> <link toc="yocto-project-qs-toc.xml"/> </topic> + <topic label="The Yocto Project Application Development Toolkit (ADT) User's Guide"> + <link toc="adt-manual-toc.xml"/> + </topic> </toc>
plugins/org.yocto.sdk.doc.user/yocto-project-qs-toc.xml new file +32 -0
@@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<toc label="The Yocto Project Quick Start" topic="html/yocto-project-qs/index.html"> + <topic label="The Yocto Project Quick Start" href="html/yocto-project-qs/index.html#fake-title"/> + <topic label="Welcome!" href="html/yocto-project-qs/index.html#welcome"/> + <topic label="Introducing the Yocto Project Development Environment" href="html/yocto-project-qs/index.html#yp-intro"/> + <topic label="What You Need and How You Get It" href="html/yocto-project-qs/index.html#resources"> + <topic label="The Linux Distribution" href="html/yocto-project-qs/index.html#the-linux-distro"/> + <topic label="The Packages" href="html/yocto-project-qs/index.html#packages"> + <topic label="Ubuntu" href="html/yocto-project-qs/index.html#ubuntu"/> + <topic label="Fedora" href="html/yocto-project-qs/index.html#fedora"/> + <topic label="openSUSE" href="html/yocto-project-qs/index.html#opensuse"/> + <topic label="CentOS" href="html/yocto-project-qs/index.html#centos"/> + </topic> + <topic label="Yocto Project Release" href="html/yocto-project-qs/index.html#releases"/> + </topic> + <topic label="A Quick Test Run" href="html/yocto-project-qs/index.html#test-run"> + <topic label="Building an Image" href="html/yocto-project-qs/index.html#building-image"/>
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
1.7.7.6
Part of the diff is not shown here. View the raw message.
Hi,
This seems like a very cool idea. What about when things change structurally for the Yocto Docs? For example, right now I am restructuring much of the Eclipse information that is in the ADT manual to move it to the development manual as part of an application development flow. It looks like your patch here includes the ADT manual and the Quick Start. The changes I am working on will eventually require the YP development manual as well.
Scott
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of [email protected]
Sent: Wednesday, July 18, 2012 6:03 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipse
From: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers,
Timo
Timo Mueller (8):
plugins/sdk.doc.user: Added plugin for the yocto project
documentation
plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual
features/org.yocto.sdk.doc/.project | 17 + features/org.yocto.sdk.doc/build.properties | 5 + features/org.yocto.sdk.doc/feature.properties | 208 ++++++ features/org.yocto.sdk.doc/feature.xml | 40 ++ features/org.yocto.sdk.doc/license.html | 237 +++++++ .../sourceTemplateFeature/feature.properties | 208 ++++++ .../sourceTemplateFeature/license.html | 237 +++++++ features/org.yocto.sdk.site/category.xml | 6 + features/org.yocto.sdk.site/site.xml | 3 + features/org.yocto.sdk/feature.xml | 5 + plugins/org.yocto.sdk.doc.user/.classpath | 6 + plugins/org.yocto.sdk.doc.user/.project | 28 + .../.settings/org.eclipse.jdt.core.prefs | 8 + .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF | 8 + .../OSGI-INF/l10n/bundle.properties | 3 + plugins/org.yocto.sdk.doc.user/about.html | 82 +++ plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml | 61 ++ plugins/org.yocto.sdk.doc.user/build.properties | 14 + .../html/adt-manual/ch01.html | 90 +++ .../html/adt-manual/ch01s02.html | 166 +++++ .../html/adt-manual/ch02.html | 450 +++++++++++++ .../html/adt-manual/ch02s02.html | 56 ++ .../html/adt-manual/ch02s03.html | 182 ++++++ .../html/adt-manual/ch03.html | 97 +++ .../html/adt-manual/ch03s02.html | 78 +++ .../html/adt-manual/ch04.html | 675 ++++++++++++++++++++ .../html/adt-manual/ch04s02.html | 94 +++ .../html/adt-manual/ch04s03.html | 77 +++ .../html/adt-manual/ch04s04.html | 37 ++ .../html/adt-manual/ch04s05.html | 65 ++ .../html/adt-manual/ch04s06.html | 100 +++ .../html/adt-manual/ch04s07.html | 161 +++++ .../html/adt-manual/ch04s08.html | 184 ++++++ .../html/adt-manual/ch05.html | 112 ++++ .../html/adt-manual/ch05s02.html | 41 ++ .../html/adt-manual/index.html | 260 ++++++++ plugins/org.yocto.sdk.doc.user/html/book.css | 1 + .../yocto-project-qs/figures/building-an-image.png | Bin 0 -> 14891 bytes .../figures/using-a-pre-built-image.png | Bin 0 -> 12733 bytes .../yocto-project-qs/figures/yocto-environment.png | Bin 0 -> 73095 bytes .../figures/yocto-project-transp.png | Bin 0 -> 8626 bytes .../html/yocto-project-qs/index.html | 542 ++++++++++++++++ plugins/org.yocto.sdk.doc.user/plugin.xml | 19 + plugins/org.yocto.sdk.doc.user/toc.xml | 9 + .../yocto-project-qs-toc.xml | 32 + 45 files changed, 4704 insertions(+), 0 deletions(-) create mode 100644 features/org.yocto.sdk.doc/.project create mode 100644 features/org.yocto.sdk.doc/build.properties create mode 100644 features/org.yocto.sdk.doc/feature.properties create mode 100644 features/org.yocto.sdk.doc/feature.xml create mode 100644 features/org.yocto.sdk.doc/license.html create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/license.html create mode 100644 plugins/org.yocto.sdk.doc.user/.classpath create mode 100644 plugins/org.yocto.sdk.doc.user/.project create mode 100644 plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs create mode 100644 plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.sdk.doc.user/about.html create mode 100644 plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/build.properties create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s06.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s07.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s08.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/book.css create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/building-an-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/using-a-pre-built-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-environment.png create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-project-transp.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/plugin.xml create mode 100644 plugins/org.yocto.sdk.doc.user/toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/yocto-project-qs-toc.xml
Signature · 6 lines
1.7.7.6 _______________________________________________ yocto mailing list [email protected] https://lists.yoctoproject.org/listinfo/yocto
Hi,
Rifenbark, Scott M wrote, On 18.07.2012 17:03:
Quoted 9 lines
Hi,
This seems like a very cool idea. What about when things change structurally for the Yocto Docs? For example, right now I am restructuring much of the Eclipse information that is in the ADT manual to move it to the development manual as part of an application development flow. It looks like your patch here includes the ADT manual and the Quick Start. The changes I am working on will eventually require the YP development manual as well.
I wanted to make sure that it is possible to generate eclipse help from the documentation and integrate it into eclipse. Starting with the development manual and the quick start guide was the obvious choice. But, as I didn't encounter any problems using the docbook eclipse stylesheet on the documentation, I suspect that integrating the other documents is also possible.
I will give it a try and let you know about the results.
Quoted 34 lines
Scott
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of [email protected]
Sent: Wednesday, July 18, 2012 6:03 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipseFrom: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers,
Timo
Quoted 10 lines
Timo Mueller (8):
plugins/sdk.doc.user: Added plugin for the yocto project
documentation
plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual
<snip>
Cheers,
Timo
Very nice... thanks
-----Original Message-----
From: Timo Müller [mailto:[email protected]]
Sent: Wednesday, July 18, 2012 11:57 PM
To: Rifenbark, Scott M
Cc: [email protected]; Timo Mueller
Subject: Re: [yocto] [RFC 0/8] Integrate yocto documentation into eclipse
Hi,
Rifenbark, Scott M wrote, On 18.07.2012 17:03:
Quoted 9 lines
Hi,
This seems like a very cool idea. What about when things change structurally for the Yocto Docs? For example, right now I am restructuring much of the Eclipse information that is in the ADT manual to move it to the development manual as part of an application development flow. It looks like your patch here includes the ADT manual and the Quick Start. The changes I am working on will eventually require the YP development manual as well.
I wanted to make sure that it is possible to generate eclipse help from the documentation and integrate it into eclipse. Starting with the development manual and the quick start guide was the obvious choice. But, as I didn't encounter any problems using the docbook eclipse stylesheet on the documentation, I suspect that integrating the other documents is also possible.
I will give it a try and let you know about the results.
Quoted 34 lines
Scott
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of [email protected]
Sent: Wednesday, July 18, 2012 6:03 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipseFrom: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers,
Timo
Quoted 10 lines
Timo Mueller (8):
plugins/sdk.doc.user: Added plugin for the yocto project
documentation
plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual
<snip>
Cheers,
Timo
Hi,
Rifenbark, Scott M wrote, On 19.07.2012 16:39:
Quoted 22 lines
Very nice... thanks
-----Original Message-----
From: Timo Müller [mailto:[email protected]]
Sent: Wednesday, July 18, 2012 11:57 PM
To: Rifenbark, Scott M
Cc: [email protected]; Timo Mueller
Subject: Re: [yocto] [RFC 0/8] Integrate yocto documentation into eclipseHi,
Rifenbark, Scott M wrote, On 18.07.2012 17:03:
Quoted 9 lines
Hi,
This seems like a very cool idea. What about when things change structurally for the Yocto Docs? For example, right now I am restructuring much of the Eclipse information that is in the ADT manual to move it to the development manual as part of an application development flow. It looks like your patch here includes the ADT manual and the Quick Start. The changes I am working on will eventually require the YP development manual as well.
Quoted 8 lines
I wanted to make sure that it is possible to generate eclipse help from the documentation and integrate it into eclipse. Starting with the development manual and the quick start guide was the obvious choice. But, as I didn't encounter any problems using the docbook eclipse stylesheet on the documentation, I suspect that integrating the other documents is also possible.
I will give it a try and let you know about the results.
As I suspected I didn't encounter any problems generating eclipse help documentation from all documentation parts (dev-manual, kernel-manual, ...). So it will be straight-forward and easy to add them to the eclipse plugin as well.
Quoted 2 lines
Quoted 2 lines
Scott
<snip>
Regards,
Timo
This will be a nice feature. Thanks!
Scott
-----Original Message-----
From: Timo Müller [mailto:[email protected]]
Sent: Thursday, July 19, 2012 11:41 PM
To: Rifenbark, Scott M
Cc: [email protected]; Timo Mueller
Subject: Re: [yocto] [RFC 0/8] Integrate yocto documentation into eclipse
Hi,
Rifenbark, Scott M wrote, On 19.07.2012 16:39:
Quoted 22 lines
Very nice... thanks
-----Original Message-----
From: Timo Müller [mailto:[email protected]]
Sent: Wednesday, July 18, 2012 11:57 PM
To: Rifenbark, Scott M
Cc: [email protected]; Timo Mueller
Subject: Re: [yocto] [RFC 0/8] Integrate yocto documentation into eclipseHi,
Rifenbark, Scott M wrote, On 18.07.2012 17:03:
Quoted 9 lines
Hi,
This seems like a very cool idea. What about when things change structurally for the Yocto Docs? For example, right now I am restructuring much of the Eclipse information that is in the ADT manual to move it to the development manual as part of an application development flow. It looks like your patch here includes the ADT manual and the Quick Start. The changes I am working on will eventually require the YP development manual as well.
Quoted 8 lines
I wanted to make sure that it is possible to generate eclipse help from the documentation and integrate it into eclipse. Starting with the development manual and the quick start guide was the obvious choice. But, as I didn't encounter any problems using the docbook eclipse stylesheet on the documentation, I suspect that integrating the other documents is also possible.
I will give it a try and let you know about the results.
As I suspected I didn't encounter any problems generating eclipse help documentation from all documentation parts (dev-manual, kernel-manual, ...). So it will be straight-forward and easy to add them to the eclipse plugin as well.
Quoted 2 lines
Quoted 2 lines
Scott
<snip>
Regards,
Timo
Hi Timo,
Can you send me the link to the branch that I can take a look at this new plug-in?
Thanks,
Jessica
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of [email protected]
Sent: Wednesday, July 18, 2012 6:03 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipse
From: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers,
Timo
Timo Mueller (8):
plugins/sdk.doc.user: Added plugin for the yocto project
documentation
plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual
features/org.yocto.sdk.doc/.project | 17 + features/org.yocto.sdk.doc/build.properties | 5 + features/org.yocto.sdk.doc/feature.properties | 208 ++++++ features/org.yocto.sdk.doc/feature.xml | 40 ++ features/org.yocto.sdk.doc/license.html | 237 +++++++ .../sourceTemplateFeature/feature.properties | 208 ++++++ .../sourceTemplateFeature/license.html | 237 +++++++ features/org.yocto.sdk.site/category.xml | 6 + features/org.yocto.sdk.site/site.xml | 3 + features/org.yocto.sdk/feature.xml | 5 + plugins/org.yocto.sdk.doc.user/.classpath | 6 + plugins/org.yocto.sdk.doc.user/.project | 28 + .../.settings/org.eclipse.jdt.core.prefs | 8 + .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF | 8 + .../OSGI-INF/l10n/bundle.properties | 3 + plugins/org.yocto.sdk.doc.user/about.html | 82 +++ plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml | 61 ++ plugins/org.yocto.sdk.doc.user/build.properties | 14 + .../html/adt-manual/ch01.html | 90 +++ .../html/adt-manual/ch01s02.html | 166 +++++ .../html/adt-manual/ch02.html | 450 +++++++++++++ .../html/adt-manual/ch02s02.html | 56 ++ .../html/adt-manual/ch02s03.html | 182 ++++++ .../html/adt-manual/ch03.html | 97 +++ .../html/adt-manual/ch03s02.html | 78 +++ .../html/adt-manual/ch04.html | 675 ++++++++++++++++++++ .../html/adt-manual/ch04s02.html | 94 +++ .../html/adt-manual/ch04s03.html | 77 +++ .../html/adt-manual/ch04s04.html | 37 ++ .../html/adt-manual/ch04s05.html | 65 ++ .../html/adt-manual/ch04s06.html | 100 +++ .../html/adt-manual/ch04s07.html | 161 +++++ .../html/adt-manual/ch04s08.html | 184 ++++++ .../html/adt-manual/ch05.html | 112 ++++ .../html/adt-manual/ch05s02.html | 41 ++ .../html/adt-manual/index.html | 260 ++++++++ plugins/org.yocto.sdk.doc.user/html/book.css | 1 + .../yocto-project-qs/figures/building-an-image.png | Bin 0 -> 14891 bytes .../figures/using-a-pre-built-image.png | Bin 0 -> 12733 bytes .../yocto-project-qs/figures/yocto-environment.png | Bin 0 -> 73095 bytes .../figures/yocto-project-transp.png | Bin 0 -> 8626 bytes .../html/yocto-project-qs/index.html | 542 ++++++++++++++++ plugins/org.yocto.sdk.doc.user/plugin.xml | 19 + plugins/org.yocto.sdk.doc.user/toc.xml | 9 + .../yocto-project-qs-toc.xml | 32 + 45 files changed, 4704 insertions(+), 0 deletions(-) create mode 100644 features/org.yocto.sdk.doc/.project create mode 100644 features/org.yocto.sdk.doc/build.properties create mode 100644 features/org.yocto.sdk.doc/feature.properties create mode 100644 features/org.yocto.sdk.doc/feature.xml create mode 100644 features/org.yocto.sdk.doc/license.html create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/license.html create mode 100644 plugins/org.yocto.sdk.doc.user/.classpath create mode 100644 plugins/org.yocto.sdk.doc.user/.project create mode 100644 plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs create mode 100644 plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.sdk.doc.user/about.html create mode 100644 plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/build.properties create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s06.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s07.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s08.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/book.css create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/building-an-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/using-a-pre-built-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-environment.png create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-project-transp.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/plugin.xml create mode 100644 plugins/org.yocto.sdk.doc.user/toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/yocto-project-qs-toc.xml
--
1.7.7.6
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto
Hi Jessica,
Zhang, Jessica wrote, On 18.07.2012 19:36:
Quoted 3 lines
Hi Timo,
Can you send me the link to the branch that I can take a look at this new plug-in?
I've worked on origin/master-indigo:
http://git.yoctoproject.org/cgit/cgit.cgi/eclipse-poky/log/?h=master-indigo
Commit ID: 49849f3d70fb05bfca76bf8be685f0531ceba908
Quoted 24 lines
Thanks,
Jessica-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of [email protected]
Sent: Wednesday, July 18, 2012 6:03 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipseFrom: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers,
Timo
Quoted 11 lines
Timo Mueller (8):
plugins/sdk.doc.user: Added plugin for the yocto project
documentation
plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual
<snip>
Best regards,
Timo
Hi Timo,
Overall, I think this is very nice enhancement to Yocto Eclipse plug-in and thanks for the RFC. Couple comments/questions:
1st. I'd think if we add this feature, it'll probably make sense for the upcoming 1.3 release in the Oct. timeframe. We just ported our plug-in to Eclipse Juno release. Can you verify it works for Juno?
2nd. We need to figure out the process to generate the content for this doc plug-in since normally the content will be finalized toward the end of a release. So is there an automated way to generate the content that ScottR (our tech writer) can use to generate the content once he's done his writing. Or he needs to inform you to create it and send the pull request?
3rd. We have autobuilder that use our eclipse plug-in headless build to build the plugin and put on the download site for update/installating. So have you verified the doc plug-in works with our existing headless build?
4th. I need to double check with our License expert regarding CCA-SA and EPL and your proposed approach and will work with you pending his comments.
Thanks,
Jessica
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of [email protected]
Sent: Wednesday, July 18, 2012 6:03 AM
To: [email protected]
Cc: Timo Mueller
Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipse
From: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers,
Timo
Timo Mueller (8):
plugins/sdk.doc.user: Added plugin for the yocto project
documentation
plugins/sdk.doc.user: Added empty table of contents feature/sdk.doc: Added feature containing yocto documentation plugins feature/sdk.doc: Added org.yocto.sdk.doc.user plugin plugins/sdk.doc.user: Added yocto quick start guide feature/sdk: Added org.yocto.sdk.doc feature. features/sdk.site: Added eclipse help feature to update site plugins/sdk.doc.user: Added yocto adt manual
features/org.yocto.sdk.doc/.project | 17 + features/org.yocto.sdk.doc/build.properties | 5 + features/org.yocto.sdk.doc/feature.properties | 208 ++++++ features/org.yocto.sdk.doc/feature.xml | 40 ++ features/org.yocto.sdk.doc/license.html | 237 +++++++ .../sourceTemplateFeature/feature.properties | 208 ++++++ .../sourceTemplateFeature/license.html | 237 +++++++ features/org.yocto.sdk.site/category.xml | 6 + features/org.yocto.sdk.site/site.xml | 3 + features/org.yocto.sdk/feature.xml | 5 + plugins/org.yocto.sdk.doc.user/.classpath | 6 + plugins/org.yocto.sdk.doc.user/.project | 28 + .../.settings/org.eclipse.jdt.core.prefs | 8 + .../org.yocto.sdk.doc.user/META-INF/MANIFEST.MF | 8 + .../OSGI-INF/l10n/bundle.properties | 3 + plugins/org.yocto.sdk.doc.user/about.html | 82 +++ plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml | 61 ++ plugins/org.yocto.sdk.doc.user/build.properties | 14 + .../html/adt-manual/ch01.html | 90 +++ .../html/adt-manual/ch01s02.html | 166 +++++ .../html/adt-manual/ch02.html | 450 +++++++++++++ .../html/adt-manual/ch02s02.html | 56 ++ .../html/adt-manual/ch02s03.html | 182 ++++++ .../html/adt-manual/ch03.html | 97 +++ .../html/adt-manual/ch03s02.html | 78 +++ .../html/adt-manual/ch04.html | 675 ++++++++++++++++++++ .../html/adt-manual/ch04s02.html | 94 +++ .../html/adt-manual/ch04s03.html | 77 +++ .../html/adt-manual/ch04s04.html | 37 ++ .../html/adt-manual/ch04s05.html | 65 ++ .../html/adt-manual/ch04s06.html | 100 +++ .../html/adt-manual/ch04s07.html | 161 +++++ .../html/adt-manual/ch04s08.html | 184 ++++++ .../html/adt-manual/ch05.html | 112 ++++ .../html/adt-manual/ch05s02.html | 41 ++ .../html/adt-manual/index.html | 260 ++++++++ plugins/org.yocto.sdk.doc.user/html/book.css | 1 + .../yocto-project-qs/figures/building-an-image.png | Bin 0 -> 14891 bytes .../figures/using-a-pre-built-image.png | Bin 0 -> 12733 bytes .../yocto-project-qs/figures/yocto-environment.png | Bin 0 -> 73095 bytes .../figures/yocto-project-transp.png | Bin 0 -> 8626 bytes .../html/yocto-project-qs/index.html | 542 ++++++++++++++++ plugins/org.yocto.sdk.doc.user/plugin.xml | 19 + plugins/org.yocto.sdk.doc.user/toc.xml | 9 + .../yocto-project-qs-toc.xml | 32 + 45 files changed, 4704 insertions(+), 0 deletions(-) create mode 100644 features/org.yocto.sdk.doc/.project create mode 100644 features/org.yocto.sdk.doc/build.properties create mode 100644 features/org.yocto.sdk.doc/feature.properties create mode 100644 features/org.yocto.sdk.doc/feature.xml create mode 100644 features/org.yocto.sdk.doc/license.html create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/feature.properties create mode 100644 features/org.yocto.sdk.doc/sourceTemplateFeature/license.html create mode 100644 plugins/org.yocto.sdk.doc.user/.classpath create mode 100644 plugins/org.yocto.sdk.doc.user/.project create mode 100644 plugins/org.yocto.sdk.doc.user/.settings/org.eclipse.jdt.core.prefs create mode 100644 plugins/org.yocto.sdk.doc.user/META-INF/MANIFEST.MF create mode 100644 plugins/org.yocto.sdk.doc.user/OSGI-INF/l10n/bundle.properties create mode 100644 plugins/org.yocto.sdk.doc.user/about.html create mode 100644 plugins/org.yocto.sdk.doc.user/adt-manual-toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/build.properties create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch01s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch02s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch03s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s03.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s04.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s06.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s07.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch04s08.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/ch05s02.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/adt-manual/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/html/book.css create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/building-an-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/using-a-pre-built-image.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-environment.png create mode 100755 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/figures/yocto-project-transp.png create mode 100644 plugins/org.yocto.sdk.doc.user/html/yocto-project-qs/index.html create mode 100644 plugins/org.yocto.sdk.doc.user/plugin.xml create mode 100644 plugins/org.yocto.sdk.doc.user/toc.xml create mode 100644 plugins/org.yocto.sdk.doc.user/yocto-project-qs-toc.xml
--
1.7.7.6
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto
Hi Jessica,
Zhang, Jessica wrote, On 22.07.2012 20:26:
Quoted 9 lines
Hi Timo,
Overall, I think this is very nice enhancement to Yocto Eclipse plug-in and thanks for the RFC. Couple comments/questions:
1st. I'd
think if we add this feature, it'll probably make sense for the upcoming 1.3 release in the Oct. timeframe. We just ported our plug-in to Eclipse Juno release. Can you verify it works for Juno?
I've tested the patches with the current Juno release (origin/master, commit: 4989ec8ba8760bf12def6990e91f3d8881af6e25). The plugin works fine within eclipse Juno as well.
Quoted 7 lines
2nd. We need to figure out the process to generate the content for this doc plug-in since normally the content will be finalized toward the end of a release. So is there an automated way to generate the content that ScottR (our tech writer) can use to generate the content once he's done his writing. Or he needs to inform you to create it and send the pull request?
I simply converted the docbook documents to eclipse help using the eclipse stylesheet provided by docbook itself. I could either provide the exact xslt call or generate the documentation as you proposed.
To do this in an automated way the calls could be added directly to the documentation build system, so the eclipse help can be generated along with the rest of the documentation output.
As the CCA-SA hasn't been approved here at my company I'm struggeling to propose patches to the doc build system and integrate the eclipse help generation.
I would be happy to contribute under the BSD license, if the "Code Submissions" clause (which would be BSD license, http://www.yoctoproject.org/about/terms-service) applies to the build system. I've already asked about this on the mailing list. I messed up with the subject ([yocto] Documentation question: How are the), but until now nobody knew if the "Code Submissions" clause really applies here.
Quoted 5 lines
3rd. We have autobuilder that use our eclipse plug-in headless build to build the plugin and put on the download site for update/installating. So have you verified the doc plug-in works with our existing headless build?
Yes, I have used the build.sh in the scripts folder to build the archive and the update site and it built without errors (and can also be installed from the generated update site). By the way is there any way to specify that the script shall use a local clone of the repository? I've been changing the GIT_URL in the script to actually achieve this.
Quoted 4 lines
4th. I need to double check with our License expert regarding CCA-SA and EPL and your proposed approach and will work with you pending his comments.
OK. Feedback is very welcome.
Quoted 25 lines
Thanks, Jessica
-----Original Message----- From: [email protected] [mailto:[email protected]] On Behalf Of [email protected] Sent: Wednesday, July 18, 2012 6:03 AM To:
[email protected] Cc: Timo Mueller Subject: [yocto] [RFC 0/8] Integrate yocto documentation into eclipseFrom: Timo Mueller <[email protected]>
Hi,
the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide.
In order to achieve this, I've generated eclipse help from yocto's documentation (adt-manual, yocto-project-qs). I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Please let me know what you think about it?
Quoted 8 lines
Yocto's documentation is licensed under the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales (CCA-SA), which is incompatible to the Eclipse Public License 1.0. Thus I've created a standalone feature to simply redistribute the documentation avoiding licensing issues. Do you agree on the way this is structured?
Cheers, Timo
<snip>
Thank you for the feedback,
Timo
Please see my comments...
Thanks,
Jessica
-----Original Message-----
Quoted 7 lines
2nd. We need to figure out the process to generate the content for this doc plug-in since normally the content will be finalized toward the end of a release. So is there an automated way to generate the content that ScottR (our tech writer) can use to generate the content once he's done his writing. Or he needs to inform you to create it and send the pull request?
I simply converted the docbook documents to eclipse help using the eclipse stylesheet provided by docbook itself. I could either provide the exact xslt call or generate the documentation as you proposed.
To do this in an automated way the calls could be added directly to the documentation build system, so the eclipse help can be generated along with the rest of the documentation output.
As the CCA-SA hasn't been approved here at my company I'm struggeling to propose patches to the doc build system and integrate the eclipse help generation.
I would be happy to contribute under the BSD license, if the "Code Submissions" clause (which would be BSD license,
http://www.yoctoproject.org/about/terms-service) applies to the build system. I've already asked about this on the mailing list. I messed up with the subject ([yocto] Documentation question: How are the), but until now nobody knew if the "Code Submissions" clause really applies here.
[JZ] I've checked with our release engineer and she pointed that according to LICENSE file under poky directory, all the file without explicitly stated will be defaulted to GPLv2. Since our doc build makefile fall into this case, your patch needs to be GPLv2.
Quoted 5 lines
3rd. We have autobuilder that use our eclipse plug-in headless build to build the plugin and put on the download site for update/installating. So have you verified the doc plug-in works with our existing headless build?
Yes, I have used the build.sh in the scripts folder to build the archive and the update site and it built without errors (and can also be installed from the generated update site).
By the way is there any way to specify that the script shall use a local clone of the repository? I've been changing the GIT_URL in the script to actually achieve this.
[JZ] I'm afraid not atm but patches are always welcome :-)
Hi Jessica,
Zhang, Jessica wrote, On 24.07.2012 01:48:
Quoted 33 lines
Please see my comments...
Thanks,
Jessica-----Original Message-----
Quoted 7 lines
2nd. We need to figure out the process to generate the content for this doc plug-in since normally the content will be finalized toward the end of a release. So is there an automated way to generate the content that ScottR (our tech writer) can use to generate the content once he's done his writing. Or he needs to inform you to create it and send the pull request?
I simply converted the docbook documents to eclipse help using the eclipse stylesheet provided by docbook itself. I could either provide the exact xslt call or generate the documentation as you proposed.
To do this in an automated way the calls could be added directly to the documentation build system, so the eclipse help can be generated along with the rest of the documentation output.
As the CCA-SA hasn't been approved here at my company I'm struggeling to propose patches to the doc build system and integrate the eclipse help generation.
I would be happy to contribute under the BSD license, if the "Code Submissions" clause (which would be BSD license,
http://www.yoctoproject.org/about/terms-service) applies to the build system. I've already asked about this on the mailing list. I messed up with the subject ([yocto] Documentation question: How are the), but until now nobody knew if the "Code Submissions" clause really applies here.
Quoted 1 line
[JZ] I've checked with our release engineer and she pointed that according to LICENSE file under poky directory, all the file without explicitly stated will be defaulted to GPLv2. Since our doc build makefile fall into this case, your patch needs to be GPLv2.
That's great news. Thank you for the clarification. I'm already working on the patches that include the eclipse help generation.
Quoted 7 lines
Quoted 6 lines
3rd. We have autobuilder that use our eclipse plug-in headless build to build the plugin and put on the download site for update/installating. So have you verified the doc plug-in works with our existing headless build?
Quoted 10 lines
Yes, I have used the
build.shin the scripts folder to build the archive and the update site and it built without errors (and can also be installed from the generated update site).
By the way is there any way to specify that the script shall use a local clone of the repository? I've been changing theGIT_URLin the script to actually achieve this.[JZ] I'm afraid not atm but patches are always welcome :-)
Best regards,
Timo