[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [tycho-dev] Documentation

Thanks Igor.

Will try to add bits to the wiki as I figure stuff out.  I think it's
perhaps tough to expect users to grok the code to work out what's
available.  Is there a policy that developers who add new features
should at least add initial documentation detailing the functionality?

Cheers,
James

On 15 February 2012 22:35, Igor Fedorenko <igor@xxxxxxxxxxxxxx> wrote:
> Tycho project documentation page [1] provides links to available
> documentation. Beyond that, you can always look at Tycho sources [2].
>
> Also, do not forget that Tycho is an opensource project and improving
> Tycho documentation is one way you can contribute (hint: anyone with
> bugzilla account can edit Eclipse Wiki).
>
> [1] http://www.eclipse.org/tycho/documentation.php
> [2] http://git.eclipse.org/c/?q=tycho
>
> --
> Regards,
> Igor
>
>
> On 12-02-15 5:25 PM, James Blackburn wrote:
>>
>> Hi All,
>>
>> I'm struggling to find documentation for features I've discovered in
>> Tycho:
>>
>> org.eclipse.tycho:tycho-versions-plugin
>> <packaging>eclipse-update-site</packaging>
>>
>> The Tycho documentation index:
>> http://wiki.eclipse.org/Tycho
>> doesn't point at any documentation.  You can get some docs via the
>> Tycho category:
>> http://wiki.eclipse.org/Category:Tycho
>> But AFAICS there's no mention of the versions-plugin.
>>
>> The eclipse-update-site type is marked as deprecated on:
>> http://wiki.eclipse.org/Tycho/Packaging_Types
>> but, interestingly, this type was generated automatically for me by
>> `mvn org.eclipse.tycho:tycho-pomgenerator-plugin:generate-poms
>> -DgroupId=...` (using tycho 0.14.0).
>>
>> I only knew about the versions plugin because I saw a post on the
>> Linux tools mailing list, and it seems other people have been stuck
>> for a while looking for an answer to this too:
>>
>> http://stackoverflow.com/questions/2848687/how-to-keep-plug-in-manifest-version-and-pom-version-in-sync-in-maven-with-tycho/
>>
>> As a new Tycho user, it's pretty touch figuring out what's available
>> without any documentation.  Am I looking in the wrong place, and are
>> these Tycho features documented elsewhere?  I've googled, but that's
>> pretty bare as well...  I'm afraid there's lots I'm missing, simply
>> because features aren't mentioned on the wiki.
>>
>> Cheers,
>> James
>> _______________________________________________
>> tycho-dev mailing list
>> tycho-dev@xxxxxxxxxxx
>> https://dev.eclipse.org/mailman/listinfo/tycho-dev
>
> _______________________________________________
> tycho-dev mailing list
> tycho-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/tycho-dev