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: [RFC 0/8] Integrate yocto documentation into eclipse
Date: Wed, 18 Jul 2012 15:02:51 +0200	[thread overview]
Message-ID: <cover.1342614895.git.timo.mueller@bmw-carit.de> (raw)

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

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



             reply	other threads:[~2012-07-18 13:03 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-18 13:02 mail [this message]
2012-07-18 13:02 ` [RFC 1/8] plugins/sdk.doc.user: Added plugin for the yocto project documentation mail
2012-07-18 13:02 ` [RFC 2/8] plugins/sdk.doc.user: Added empty table of contents mail
2012-07-18 13:02 ` [RFC 3/8] feature/sdk.doc: Added feature containing yocto documentation plugins mail
2012-07-18 13:02 ` [RFC 4/8] feature/sdk.doc: Added org.yocto.sdk.doc.user plugin mail
2012-07-18 13:02 ` [RFC 5/8] plugins/sdk.doc.user: Added yocto quick start guide mail
2012-07-18 13:02 ` [RFC 6/8] feature/sdk: Added org.yocto.sdk.doc feature mail
2012-07-18 13:02 ` [RFC 7/8] features/sdk.site: Added eclipse help feature to update site mail
2012-07-18 13:02 ` [RFC 8/8] plugins/sdk.doc.user: Added yocto adt manual mail
2012-07-18 15:03 ` [RFC 0/8] Integrate yocto documentation into eclipse Rifenbark, Scott M
2012-07-19  6:56   ` Timo Müller
2012-07-19 14:39     ` Rifenbark, Scott M
2012-07-20  6:41       ` Timo Müller
2012-07-20 15:02         ` Rifenbark, Scott M
2012-07-18 17:36 ` Zhang, Jessica
2012-07-19  6:37   ` Timo Müller
2012-07-22 18:26 ` Zhang, Jessica
2012-07-23 15:55   ` Timo Müller
2012-07-23 23:48     ` Zhang, Jessica
2012-07-26  6:21       ` 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.1342614895.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.