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

[Timo Müller]

Hi Jessica,


Zhang, Jessica wrote, On 24.07.2012 01:48:
> Please see my comments...
>
> Thanks,
> Jessica
>
> -----Original Message-----
>
>>
>> 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.
>
> [JZ] I've checked with our release engineer and she pointed that according to LICENSE file under poky directory, all the file without explicitly stated will be defaulted to GPLv2.  Since our doc build makefile fall into this case, your patch needs to be GPLv2.

That's great news. Thank you for the clarification. I'm already working 
on the patches that include the eclipse help generation.

>
>>
>> 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.
>
> [JZ] I'm afraid not atm but patches are always welcome :-)
>
>


Best regards,
Timo