[yocto] [RFC 0/8] Integrate yocto documentation into eclipse

[Timo Müller]

Hi Jessica,

Zhang, Jessica wrote, On 22.07.2012 20:26:
> Hi Timo,
>
> Overall, I think this is very nice enhancement to Yocto Eclipse
> plug-in and thanks for the RFC. Couple comments/questions:
 >
 > 1st.  I'd
> think if we add this feature, it'll probably make sense for the
> upcoming 1.3 release in the Oct. timeframe.  We just ported our
> plug-in to Eclipse Juno release.  Can you verify it works for Juno?

I've tested the patches with the current Juno release (origin/master, 
commit: 4989ec8ba8760bf12def6990e91f3d8881af6e25). The plugin works fine 
within eclipse Juno as well.

>
> 2nd. We need to figure out the process to generate the content for
> this doc plug-in since normally the content will be finalized toward
> the end of a release.  So is there an automated way to generate the
> content that ScottR (our tech writer) can use to generate the content
> once he's done his writing.  Or he needs to inform you to create it
> and send the pull request?

I simply converted the docbook documents to eclipse help using the 
eclipse stylesheet provided by docbook itself. I could either provide 
the exact xslt call or generate the documentation as you proposed.

To do this in an automated way the calls could be added directly to the 
documentation build system, so the eclipse help can be generated along 
with the rest of the documentation output.

As the CCA-SA hasn't been approved here at my company I'm struggeling to 
propose patches to the doc build system and integrate the eclipse help 
generation.
I would be happy to contribute under the BSD license, if the "Code 
Submissions" clause (which would be BSD license, 
http://www.yoctoproject.org/about/terms-service) applies to the build 
system. I've already asked about this on the mailing list. I messed up 
with the subject ([yocto] Documentation question: How are the), but 
until now nobody knew if the "Code Submissions" clause really applies here.

>
> 3rd. We have autobuilder that use our eclipse plug-in headless build
> to build the plugin and put on the download site for
> update/installating.  So have you verified the doc plug-in works with
> our existing headless build?

Yes, I have used the build.sh in the scripts folder to build the archive 
and the update site and it built without errors (and can also be 
installed from the generated update site).
By the way is there any way to specify that the script shall use a local 
clone of the repository? I've been changing the GIT_URL in the script to 
actually achieve this.

>
> 4th.  I need to double check with our License expert regarding CCA-SA
> and EPL and your proposed approach and will work with you pending his
> comments.

OK. Feedback is very welcome.

>
>
> Thanks, Jessica
>
> -----Original Message----- From: yocto-bounces at yoctoproject.org
> [mailto:yocto-bounces at yoctoproject.org] On Behalf Of
> mail at timomueller.eu Sent: Wednesday, July 18, 2012 6:03 AM To:
> yocto at yoctoproject.org Cc: Timo Mueller Subject: [yocto] [RFC 0/8]
> Integrate yocto documentation into eclipse
>
> From: Timo Mueller <timo.mueller at 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
>

<snip>

Thank you for the feedback,
Timo