[yocto] [RFCv3 0/7][eclipse-poky] Integrate yocto documentation into eclipse

mail at timomueller.eu mail at timomueller.eu
Thu Dec 6 07:48:31 PST 2012


From: Timo Mueller <timo.mueller at bmw-carit.de>

Hi,

since the last proposal some things have changed:
1. Eclipse help generation is now part of the yocto-docs project
(currently available in the origin/timo branch)
2. We agreed that the plugin should be licensed under the EPL v1.0
instead of having a separate documentation plugin licensed under the
CCA-SA 2.0 UK.

The last patch set was adding generated eclipse help files (html) to
the repository. 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.
Also the eclipse help is now part of the user.doc plugin and no longer
contained in a separate plugin/feature.

Rational from the original patch:
<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 (7):
  plugins/sdk.ide.doc.user: Add empty eclipse help
  plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto
    documentation
  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/generat-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

 .../META-INF/MANIFEST.MF                           |    3 +-
 plugins/org.yocto.sdk.ide.doc.user/about.html.in   |  166 ++++++++++++++++++++
 .../org.yocto.sdk.ide.doc.user/build.properties    |    9 +-
 plugins/org.yocto.sdk.ide.doc.user/html/book.css   |    1 +
 plugins/org.yocto.sdk.ide.doc.user/plugin.xml      |   31 ++++
 plugins/org.yocto.sdk.ide.doc.user/toc.xml         |   21 +++
 scripts/build.sh                                   |    7 +
 scripts/generate_doc.sh                            |   91 +++++++++++
 8 files changed, 326 insertions(+), 3 deletions(-)
 create mode 100644 plugins/org.yocto.sdk.ide.doc.user/about.html.in
 create mode 100644 plugins/org.yocto.sdk.ide.doc.user/html/book.css
 create mode 100644 plugins/org.yocto.sdk.ide.doc.user/toc.xml
 create mode 100755 scripts/generate_doc.sh

-- 
1.7.7.6




More information about the yocto mailing list