Re: [yocto] [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse
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
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-boun...@yoctoproject.org [mailto:yocto-boun...@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
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:
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.
the documentation of the yocto project can currently be viewed online or as a
separate pdf. When using the eclipse ide to develop software on base of a yocto
sysroot and toolchain it would be convenient to access the relevant parts of
the documentation from within the ide.
I have intergrated this
documentation in the ide and it can now be accessed through the eclipse help
center (Help -> Help Contents).
Best regards
Timo
Timo Mueller (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
[yocto] [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse
From: Timo Mueller 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: 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. the documentation of the yocto project can currently be viewed online or as a separate pdf. When using the eclipse ide to develop software on base of a yocto sysroot and toolchain it would be convenient to access the relevant parts of the documentation from within the ide. I have intergrated this documentation in the ide and it can now be accessed through the eclipse help center (Help -> Help Contents). Best regards Timo Timo Mueller (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 ___
