All of lore.kernel.org
 help / color / mirror / Atom feed
From: mail@timomueller.eu
To: yocto@yoctoproject.org
Cc: Timo Mueller <timo.mueller@bmw-carit.de>
Subject: [RFCv3 0/7][eclipse-poky] Integrate yocto documentation into eclipse
Date: Thu,  6 Dec 2012 16:48:31 +0100	[thread overview]
Message-ID: <cover.1354805521.git.timo.mueller@bmw-carit.de> (raw)

From: Timo Mueller <timo.mueller@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



             reply	other threads:[~2012-12-06 15:48 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-12-06 15:48 mail [this message]
2012-12-06 15:48 ` [RFCv3 1/7] plugins/sdk.ide.doc.user: Add empty eclipse help mail
2012-12-06 15:48 ` [RFCv3 2/7] plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation mail
2012-12-06 15:48 ` [RFCv3 3/7] scripts/generate_doc.sh: Add script to handle eclipse help generation mail
2012-12-06 15:48 ` [RFCv3 4/7] plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents mail
2012-12-06 15:48 ` [RFCv3 5/7] scripts/generat-doc.sh: Copy generated eclipse help into the user.doc plugin mail
2012-12-06 15:48 ` [RFCv3 6/7] scripts/build.sh: Add documentation generation to the default build mail
2012-12-06 15:48 ` [RFCv3 7/7] (TEMPORARY): Use origin/timo branch of yocto docs project mail
2012-12-12 13:09 ` [RFCv3 0/7][eclipse-poky] Integrate yocto documentation into eclipse Timo Müller
2012-12-14 23:37   ` Zhang, Jessica
2012-12-18  8:33     ` Timo Müller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1354805521.git.timo.mueller@bmw-carit.de \
    --to=mail@timomueller.eu \
    --cc=timo.mueller@bmw-carit.de \
    --cc=yocto@yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.