Integrate yocto documentation into eclipse
v3 cover Integrate yocto documentation into eclipse
From: Timo Mueller <[email protected]>
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
Signature · 1 line
1.7.7.6
RFC v3 1/7 plugins/sdk.ide.doc.user: Add empty eclipse help
From: Timo Mueller <[email protected]>
Adds yocto specific eclipse help to the plugin. The help is currently empty but will contain the official yocto documentation later.
--- .../META-INF/MANIFEST.MF | 3 ++- .../org.yocto.sdk.ide.doc.user/build.properties | 7 +++++-- plugins/org.yocto.sdk.ide.doc.user/html/book.css | 1 + plugins/org.yocto.sdk.ide.doc.user/plugin.xml | 7 +++++++ plugins/org.yocto.sdk.ide.doc.user/toc.xml | 3 +++ 5 files changed, 18 insertions(+), 3 deletions(-) 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
plugins/org.yocto.sdk.ide.doc.user/META-INF/MANIFEST.MF +2 -1
@@ -5,4 +5,5 @@ Bundle-SymbolicName: org.yocto.sdk.ide.doc.user;singleton:=true Bundle-Version: 1.2.0.qualifier Bundle-Vendor: %Bundle-Vendor Bundle-RequiredExecutionEnvironment: JavaSE-1.6 -Require-Bundle: org.eclipse.ui.cheatsheets +Require-Bundle: org.eclipse.ui.cheatsheets, + org.eclipse.help
plugins/org.yocto.sdk.ide.doc.user/build.properties +5 -2
@@ -2,5 +2,8 @@ bin.includes = plugin.xml,\ .,\ META-INF/,\ OSGI-INF/,\ - cheatsheets/ -src.includes = cheatsheets/ + cheatsheets/,\ + html/,\ + toc.xml +src.includes = cheatsheets/,\ + html/
plugins/org.yocto.sdk.ide.doc.user/html/book.css new file +1 -0
@@ -0,0 +1 @@ +@import "PLUGINS_ROOT/PRODUCT_PLUGIN/book.css";
plugins/org.yocto.sdk.ide.doc.user/plugin.xml +7 -0
@@ -10,4 +10,11 @@ name="%cheatsheet.name"> </cheatsheet> </extension> + <extension + point="org.eclipse.help.toc"> + <toc + file="toc.xml" + primary="true"> + </toc> + </extension> </plugin>
plugins/org.yocto.sdk.ide.doc.user/toc.xml new file +3 -0
@@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="UTF-8"?> + <toc label="The Yocto Project Documentation"> + </toc>
Signature · 1 line
1.7.7.6
RFC v3 2/7 plugins/sdk.ide.doc.user: Add about.html to prepare addition of yocto documentation
From: Timo Mueller <[email protected]>
As documentation is licensed under CCA-SA 2.0 UK and the plugin itself is licensed under EPL v1.0 an about file needs to be added to the plugin identifying the third party content.
--- plugins/org.yocto.sdk.ide.doc.user/about.html.in | 166 ++++++++++++++++++++ .../org.yocto.sdk.ide.doc.user/build.properties | 6 +- 2 files changed, 170 insertions(+), 2 deletions(-) create mode 100644 plugins/org.yocto.sdk.ide.doc.user/about.html.in
plugins/org.yocto.sdk.ide.doc.user/about.html.in new file +166 -0
@@ -0,0 +1,166 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> +<title>About</title> +</head> +<body lang="EN-US"> + <h2>About This Content</h2> + + <p> + <em>December, 2012</em> + </p> + <h3>License</h3> + + <p> + Copyright (c) 2010 Intel, Inc. and others. + All rights reserved. This program and the accompanying materials + are made available under the terms of the Eclipse Public License v1.0 + which accompanies this distribution, and is available at <br /> + <a href="http://www.eclipse.org/legal/epl-v10.html"> + http://www.eclipse.org/legal/epl-v10.html + </a> + </p> + + <h3>Third Party Content</h3> + <p>The Content includes items that have been sourced from the Yocto project + as set out below. If you did not receive this Content directly + from the Linux Foundation, the following is provided for + informational purposes only, and you should look to the + Redistributor's license for terms and conditions of use.</p> + <p> + <strong> + Yocto Project Quick Start + </strong> + <br /> + <br /> + This short document lets you get started with the Yocto Project + quickly and start building an image. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-yocto-project-qs@ + <br /> + <br /> + <strong> + The Yocto Project Application Developer's Guide: + </strong> + <br /> + <br /> + This manual shows you how to setup and use the Application Development + Toolkit (ADT) and stand-alone cross-development toolchains so you can + develop user-space applications. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-adt-manual@ + <br /> + <br /> + <strong> + The Yocto Project Development Manual: + </strong> + <br /> + <br /> + This manual describes how to use the Yocto Project to develop + embedded Linux images and user-space applications to run on + targeted devices. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-dev-manual@ + <br /> + <br /> + <strong> + The Yocto Project Reference Manual: + </strong> + <br /> + <br /> + This manual is the complete reference guide to the Poky component. + It also contains a chapter on Board Support Package (BSP) development. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-poky-ref-manual@ + <br /> + <br /> + <strong> + The Yocto Project Board Support Package (BSP) Developer's Guide: + </strong> + <br /> + <br /> + This brief document defines a structure for BSP components. + Having a commonly understood layout encourages standardization. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-bsp-guide@ + <br /> + <br /> + <strong> + Yocto Project Kernel Architecture and Use Manual: + </strong> + <br /> + <br /> + This document describes the architecture of the Yocto Project + kernel and provides some work flow examples. + <br /> + <br /> + <em>License:</em> + <a href="http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode"> + http://creativecommons.org/licenses/by-sa/2.0/uk/legalcode + </a> + <br /> + <em>Source Code Repository:</em> + <a href="git://git.yoctoproject.org/yocto-docs"> + git://git.yoctoproject.org/yocto-docs + </a> + <br /> + <em>Commit:</em> @COMMIT_ID-kernel-manual@ + </p> +</body>
plugins/org.yocto.sdk.ide.doc.user/build.properties +4 -2
@@ -4,6 +4,8 @@ bin.includes = plugin.xml,\ OSGI-INF/,\ cheatsheets/,\ html/,\ - toc.xml + toc.xml,\ + about.html src.includes = cheatsheets/,\ - html/ + html/,\ + about.html
Signature · 1 line
1.7.7.6
RFC v3 3/7 scripts/generate_doc.sh: Add script to handle eclipse help generation
From: Timo Mueller <[email protected]>
This script will checkout the yocto-docs project containing the official yocto documentation. After successful checkout the eclipse help is generated and the about.html file of the doc.user plugin is created.
--- scripts/generate_doc.sh | 84 +++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 84 insertions(+), 0 deletions(-) create mode 100755 scripts/generate_doc.sh
scripts/generate_doc.sh new file +84 -0
@@ -0,0 +1,84 @@ +#!/bin/sh + +help() +{ + echo "Generate and add eclipse help from yocto's documentation" + echo "Usage: $0 BRANCH_NAME PLUGIN_FOLDER" + echo " $0 -t TAG_NAME PLUGIN_FOLDER" + echo "" + echo "Options:" + echo "-h - display this help and exit" + echo "-t TAG_NAME - tag to build the documentation upon" + echo "BRANCH_NAME - branch to build the documentation upon" + echo "PLUGIN_FOLDER - root folder of the eclipse-poky project" + exit 1 +} + +fail () +{ + local retval=$1 + shift $1 + echo "[Fail $retval]: $*" + echo "BUILD_TOP=${BUILD_TOP}" + cd ${TOP} + exit ${retval} +} + +CHECKOUT_TAG=0 +while getopts ":ht" opt; do + case $opt in + h) + help + ;; + t) + CHECKOUT_TAG=1 + ;; + esac +done +shift $(($OPTIND - 1)) + +if [ $# -ne 2 ]; then + help +fi + +if [ $CHECKOUT_TAG -eq 0 ]; then + REFERENCE=origin/$1 +else + REFERENCE=$1 +fi +PLUGIN_FOLDER=$2 + +TOP=`pwd` + +DOC_DIR=${PLUGIN_FOLDER}/docs +rm -rf ${DOC_DIR} +DOC_PLUGIN_DIR=${PLUGIN_FOLDER}/plugins/org.yocto.sdk.ide.doc.user +DOC_HTML_DIR=${DOC_PLUGIN_DIR}/html/ + +# git clone +DOC_GIT=git://git.yoctoproject.org/yocto-docs.git +git clone ${DOC_GIT} ${DOC_DIR} || fail $? "git clone ${DOC_GIT}" +cd ${DOC_DIR} +git checkout ${REFERENCE} || fail $? "git checkout ${REFERENCE}" +COMMIT_ID=`git rev-parse HEAD` + +# build and copy +DOCS="yocto-project-qs adt-manual kernel-manual \ + bsp-guide poky-ref-manual dev-manual" + +cd documentation +ECLIPSE_TARGET_AVAILABLE=`make -q eclipse &> /dev/null; echo $?` +if [ ${ECLIPSE_TARGET_AVAILABLE} -ne 1 ]; then + echo "WARNING:" + echo "This version does not support generating eclipse help" + echo "Documentation will not be available in eclipse" + exit 1 +fi + +for DOC in ${DOCS}; do + make DOC=${DOC} eclipse; +done + +sed -e "s/@.*@/${COMMIT_ID}/" < ${DOC_PLUGIN_DIR}/about.html.in > ${DOC_PLUGIN_DIR}/about.html + +cd ${TOP}
Signature · 1 line
1.7.7.6
RFC v3 4/7 plugins/sdk.ide.doc.user: Add yocto documentation to the table of contents
From: Timo Mueller <[email protected]>
The separate yocto manuals are added to the table of contents to prepare their inclusion into the plugin.
--- plugins/org.yocto.sdk.ide.doc.user/plugin.xml | 24 ++++++++++++++++++++++++ plugins/org.yocto.sdk.ide.doc.user/toc.xml | 18 ++++++++++++++++++ 2 files changed, 42 insertions(+), 0 deletions(-)
plugins/org.yocto.sdk.ide.doc.user/plugin.xml +24 -0
@@ -16,5 +16,29 @@ file="toc.xml" primary="true"> </toc> + <toc + file="html/adt-manual-toc.xml" + primary="false"> + </toc> + <toc + file="html/yocto-project-qs-toc.xml" + primary="false"> + </toc> + <toc + file="html/dev-manual-toc.xml" + primary="false"> + </toc> + <toc + file="html/poky-ref-manual-toc.xml" + primary="false"> + </toc> + <toc + file="html/bsp-guide-toc.xml" + primary="false"> + </toc> + <toc + file="html/kernel-manual-toc.xml" + primary="false"> + </toc> </extension> </plugin>
plugins/org.yocto.sdk.ide.doc.user/toc.xml +18 -0
@@ -1,3 +1,21 @@ <?xml version="1.0" encoding="UTF-8"?> <toc label="The Yocto Project Documentation"> + <topic label="The Yocto Project Quick Start"> + <link toc="html/yocto-project-qs-toc.xml"/> + </topic> + <topic label="The·Yocto·Project·Application·Developer's·Guide"> + <link toc="html/adt-manual-toc.xml"/> + </topic> + <topic label="The Yocto Project Development Manual"> + <link toc="html/dev-manual-toc.xml"/> + </topic> + <topic label="The Yocto Project Reference Manual"> + <link toc="html/poky-ref-manual-toc.xml"/> + </topic> + <topic label="The Yocto Project Board Support Package Developer's Guide"> + <link toc="html/bsp-guide-toc.xml"/> + </topic> + <topic label="The Yocto Project Kernel Architecture and Use Manual"> + <link toc="html/kernel-manual-toc.xml"/> + </topic> </toc>
Signature · 1 line
1.7.7.6
RFC v3 5/7 scripts/generat-doc.sh: Copy generated eclipse help into the user.doc plugin
From: Timo Mueller <[email protected]>
After successful generation the eclipse help files and the table of contents of each manual are copied to the user.doc plugin.
--- scripts/generate_doc.sh | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-)
scripts/generate_doc.sh +2 -0
@@ -77,6 +77,8 @@ fi for DOC in ${DOCS}; do make DOC=${DOC} eclipse; + cp -rf ${DOC}/eclipse/html/* ${DOC_HTML_DIR} + cp -f ${DOC}/eclipse/${DOC}-toc.xml ${DOC_HTML_DIR} done sed -e "s/@.*@/${COMMIT_ID}/" < ${DOC_PLUGIN_DIR}/about.html.in > ${DOC_PLUGIN_DIR}/about.html
Signature · 1 line
1.7.7.6
RFC v3 6/7 scripts/build.sh: Add documentation generation to the default build
From: Timo Mueller <[email protected]>
When building the plugin the matching documentation is automatically generated and added to the user.doc plugin prior to the plugin build.
--- scripts/build.sh | 7 +++++++ 1 files changed, 7 insertions(+), 0 deletions(-)
scripts/build.sh +7 -0
@@ -108,6 +108,13 @@ git checkout origin/${BRANCH} || fail $? "git checkout origin/${BRANCH}" git checkout ${TAG} || fail $? "git checkout ${TAG}" cd ${TOP} +# generate and add documentation +if [ "${TAG}" = "HEAD" ]; then + ${GIT_DIR}/scripts/generate_doc.sh ${BRANCH} ${GIT_DIR} +else + ${GIT_DIR}/scripts/generate_doc.sh -t ${TAG} ${GIT_DIR} +fi + #build java -jar ${LAUNCHER} -application org.eclipse.ant.core.antRunner -buildfile ${BUILDFILE} -DbaseLocation=${ECLIPSE_BASE} -Dbuilder=${GIT_DIR}/features/org.yocto.bc.headless.build -DbuildDirectory=${BUILD_DIR} -DotherSrcDirectory=${GIT_DIR} -DbuildId=${RELEASE} || fail $? "normal build" java -jar ${LAUNCHER} -application org.eclipse.ant.core.antRunner -buildfile ${BUILDFILE} -DbaseLocation=${ECLIPSE_BASE} -Dbuilder=${GIT_DIR}/features/org.yocto.sdk.headless.build -DbuildDirectory=${BUILD_DIR} -DotherSrcDirectory=${GIT_DIR} -DbuildId=${RELEASE} || fail $? "normal build"
Signature · 1 line
1.7.7.6
RFC v3 7/7 (TEMPORARY): Use origin/timo branch of yocto docs project
From: Timo Mueller <[email protected]>
As the eclipse generation is currently not part of the master the generation is always using the origin/timo branch to generate the eclipse help. This patch is added for testing purposes only.
DO NOT MERGE THIS PATCH UPSTREAM - ONLY APPLY LOCALLY FOR TESTING
--- scripts/generate_doc.sh | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-)
scripts/generate_doc.sh +5 -0
@@ -48,6 +48,11 @@ else fi PLUGIN_FOLDER=$2 +# ==================================================================== +# TODO remove this section if eclipse generation is merged into master +REFERENCE=origin/timo +# ==================================================================== + TOP=`pwd` DOC_DIR=${PLUGIN_FOLDER}/docs
Signature · 1 line
1.7.7.6
Hi,
[email protected] wrote, On 06.12.2012 16:48:
Quoted 56 lines
From: Timo Mueller <[email protected]>
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
TimoTimo 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(-)
Quoted 5 lines
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.xmlcreate mode 100755scripts/generate_doc.sh
The name of the poky-ref-manual will be changed to ref-manual. This change has an impact on this patch series, since the name is used in the generate-doc shell script.
But with the temporary fix in patch 7, the timo branch is used, which will for the time being remain unaffected by the name changes. This way you can test the documentation integration proposed in this patch set.
I would like to get your opinion on the general approach to integrate the documentation into eclipse. If it fits into the eclipse-poky project in general, I will rewrite this patch series to reflect the changes. The rewrite will also remove the "the" from the different help chapters (as Scott pointed out to me). I also agreed with Scott that once this approach is agreed on I will provide the necessary patches to the timo branch of the yocto-docs project and he will merge the eclipse generation into the master of the project.
Best regards,
Timo
PS: I also apologize for not signing off the patch series. I will make up for that in the reworked patches.
Hi Timo,
Sorry for the delay, but finally got a chance to look into these patches. I like how it automate the docgen and integrate them into eclipse. The concern that I'm having is, it seems converting all the Yocto Project Docs, originally I thought only for ADT manual. So to view these doc in eclipse are nice, but since we don't have some corresponding feature support in eclipse plug-in, it'll look awkward to combine these docs with ADT plugin. BTW, to support our bitbake commander plug-in running on windows usage, we recently split the plug-in into 2 features: ADT and bitbake commander and the doc plug-in is part of ADT feature. So I'd suggest, if we want to show all the docs, probably create a separate Yocto Doc Feature. If we want to combine with ADT plug-in, then probably only covert the ADT manual content generation and integration. Make sense?
Thanks,
Jessica
-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Timo Müller
Sent: Wednesday, December 12, 2012 5:10 AM
To: [email protected]
Cc: Timo Mueller
Subject: Re: [yocto] [RFCv3 0/7][eclipse-poky] Integrate yocto documentation into eclipse
Hi,
[email protected] wrote, On 06.12.2012 16:48:
Quoted 55 lines
From: Timo Mueller <[email protected]>
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
TimoTimo 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(-)
Quoted 5 lines
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.xmlcreate mode 100755scripts/generate_doc.sh
The name of the poky-ref-manual will be changed to ref-manual. This change has an impact on this patch series, since the name is used in the generate-doc shell script.
But with the temporary fix in patch 7, the timo branch is used, which will for the time being remain unaffected by the name changes. This way you can test the documentation integration proposed in this patch set.
I would like to get your opinion on the general approach to integrate the documentation into eclipse. If it fits into the eclipse-poky project in general, I will rewrite this patch series to reflect the changes. The rewrite will also remove the "the" from the different help chapters (as Scott pointed out to me). I also agreed with Scott that once this approach is agreed on I will provide the necessary patches to the timo branch of the yocto-docs project and he will merge the eclipse generation into the master of the project.
Best regards,
Timo
PS: I also apologize for not signing off the patch series. I will make up for that in the reworked patches.
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto
Hi Jessica,
Zhang, Jessica wrote, On 15.12.2012 00:37:
Quoted 6 lines
Hi Timo,
Sorry for the delay, but finally got a chance to look into these patches. I like how it automate the docgen and integrate them into eclipse. The concern that I'm having is, it seems converting all the Yocto Project Docs, originally I thought only for ADT manual.
The first version of this RFC was meant to be a proof of concept, that's why I only included the ADT manual.
One of the reasons why I integrated all manuals are the links between the different documents. The links pointing to documentation at yoctoprojects.org are rewritten to point to the documentation inside eclipse (I'm using the same mechanism as the mega-manual). So there's no need for internet connectivity and the user doesn't have to leave eclipse.
Quoted 4 lines
So to view
these doc in eclipse are nice, but since we don't have some corresponding feature support in eclipse plug-in, it'll look awkward to combine these docs with ADT plugin.
I guess for some manuals it makes more sense to have them inside of eclipse than for others. But I personally like that everything is in one place, either just on the website, in the PDFs or in eclipse.
Quoted 7 lines
BTW, to support our bitbake
commander plug-in running on windows usage, we recently split the plug-in into 2 features: ADT and bitbake commander and the doc plug-in is part of ADT feature. So I'd suggest, if we want to show all the docs, probably create a separate Yocto Doc Feature. If we want to combine with ADT plug-in, then probably only covert the ADT manual content generation and integration. Make sense?
Yes. Creating a separate feature seems like a good idea. I will rewrite the patch series accordingly.
Quoted 94 lines
Thanks,
Jessica-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf Of Timo Müller
Sent: Wednesday, December 12, 2012 5:10 AM
To: [email protected]
Cc: Timo Mueller
Subject: Re: [yocto] [RFCv3 0/7][eclipse-poky] Integrate yocto documentation into eclipseHi,
[email protected] wrote, On 06.12.2012 16:48:
Quoted 55 lines
From: Timo Mueller <[email protected]>
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
TimoTimo 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(-)Quoted 5 lines
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.xmlcreate mode 100755scripts/generate_doc.shThe name of the poky-ref-manual will be changed to ref-manual. This change has an impact on this patch series, since the name is used in the generate-doc shell script.
But with the temporary fix in patch 7, the timo branch is used, which will for the time being remain unaffected by the name changes. This way you can test the documentation integration proposed in this patch set.I would like to get your opinion on the general approach to integrate the documentation into eclipse. If it fits into the eclipse-poky project in general, I will rewrite this patch series to reflect the changes. The rewrite will also remove the "the" from the different help chapters (as Scott pointed out to me).
I also agreed with Scott that once this approach is agreed on I will provide the necessary patches to the timo branch of the yocto-docs project and he will merge the eclipse generation into the master of the project.Best regards,
Timo
Quoted 7 lines
PS: I also apologize for not signing off the patch series. I will make up for that in the reworked patches.
_______________________________________________
yocto mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/yocto
Best regards,
Timo