Skip to content

RFC Integrate yocto documentation into eclipse

Timo Mueller yocto 5 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 RFC Latest12 patches 1 replyIn review
  2. v4 RFC13 patches 1 replySuperseded
  3. v3 RFC7 patches 3 repliesSuperseded
Earlier versions · 2
VersionPostedPatchesRepliesStatus
v2 RFC12 patches0 repliesSuperseded
v1 RFC8 patches11 repliesSuperseded

Changes in v5 from the cover letter

Hi,

Patches in v5 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/12features/sdk.site: Fixed typo in category namefeatures/org.yocto.sdk.site/site.xml+1 -10 replies
2/12Fixed typo in version variable namefeatures/org.yocto.bc.headless.build/customTargets.xml features/org.yocto.sdk.headless.build/customTargets.xml features/org.yocto.sdk.site/category.xml +1 more+9 -90 replies
3/12plugins/sdk.ide.doc.user: Add empty eclipse helpplugins/org.yocto.doc.user/.classpath plugins/org.yocto.doc.user/.project plugins/org.yocto.doc.user/META-INF/MANIFEST.MF +5 more+67 -00 replies
4/12plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentationplugins/org.yocto.doc.user/about.html.in plugins/org.yocto.doc.user/build.properties+193 -20 replies
5/12features/org.yocto.doc: Add new feature containing yocto project documentationfeatures/org.yocto.doc/.project features/org.yocto.doc/build.properties features/org.yocto.doc/feature.properties +2 more+325 -00 replies
6/12features/doc.headless.build: Added headless build for yocto.doc featurefeatures/org.yocto.doc.headless.build/.project features/org.yocto.doc.headless.build/build.properties features/org.yocto.doc.headless.build/customTargets.xml+485 -00 replies
7/12features/sdk.site: Added yocto.doc feature to update sitefeatures/org.yocto.sdk.site/category.xml features/org.yocto.sdk.site/site.xml+8 -00 replies
8/12scripts/build.sh: Added yocto.doc feature to buildscripts/build.sh+9 -20 replies
9/12scripts/generate-doc.sh: Add script to handle eclipse help generationscripts/generate-doc.sh+85 -00 replies
10/12plugins/sdk.ide.doc.user: Add yocto documentation to the table of contentsplugins/org.yocto.doc.user/plugin.xml plugins/org.yocto.doc.user/toc.xml+49 -00 replies
11/12scripts/generate-doc.sh: Copy generated eclipse help into the user.doc pluginscripts/generate-doc.sh+2 -00 replies
12/12scripts/build.sh: Add documentation generation to the default buildscripts/build.sh+7 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v5 yet.

Read the v5 thread

Cover letter [RFC v5 00/12][eclipse-poky] Integrate yocto documentation into eclipse

From: Timo Mueller <[email protected]>

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:
<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 (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
Signature · 1 line
1.7.11.7