Re: [RFC v4 00/13][eclipse-poky] Integrate yocto documentation into eclipse


Zhang, Jessica
 

Hi Timo,

Thanks for the patch and everything looks good. So question to you and Scott, what's the plan from the doc site that we need to coordinate to have this merged into master.

Thanks,
Jessica

-----Original Message-----
From: yocto-bounces@... [mailto:yocto-bounces@...] On Behalf Of Timo Mueller
Sent: Wednesday, January 30, 2013 6:01 AM
To: yocto@...
Cc: Timo Mueller
Subject: [yocto] [RFC v4 00/13][eclipse-poky] Integrate yocto documentation into eclipse

From: Timo Mueller <timo.mueller@...>

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 (13):
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
(TEMPORARY): Use origin/timo branch of yocto docs project

.../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 | 166 +++++++++++++
plugins/org.yocto.doc.user/build.properties | 9 +
plugins/org.yocto.doc.user/html/book.css | 1 +
plugins/org.yocto.doc.user/plugin.xml | 35 +++
plugins/org.yocto.doc.user/toc.xml | 21 ++
scripts/build.sh | 18 +-
scripts/generate-doc.sh | 91 +++++++
23 files changed, 1212 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@...
https://lists.yoctoproject.org/listinfo/yocto

Join yocto@lists.yoctoproject.org to automatically receive all group messages.