[GRASS-dev] SUBMITTING to Trac

[Vaclav Petras]

On Wed, Jun 11, 2014 at 10:53 PM, Vaclav Petras <wenzeslaus at gmail.com>
wrote:

>
>
>
> On Wed, Jun 11, 2014 at 1:41 PM, Martin Landa <landa.martin at gmail.com>
> wrote:
>
>> Hi,
>>
>> 2014-06-10 15:26 GMT+02:00 Vaclav Petras <wenzeslaus at gmail.com>:
>> >>> when updating SUBMITTING files we need to touch all the files in all
>> >>> the branches. I would suggest to move this files to Trac wiki. What do
>> >>> you think?
>> >>
>> >>
>> > Yes, see
>> >
>> > http://trac.osgeo.org/grass/ticket/2103 Make SUBMITTING files more
>> > accessible
>> >
>> > Putting them to Trac seems the most easy think (comparing to creating
>> HTML,
>> > putting them to Doxygen, etc.).
>>
>> I started with SUBMITTING file [1]. Any review is welcome. The process
>> of transferring plain files to Trac wiki is quite time consuming, so I
>> will appreciate if anyone helps with other submitting files (just let
>> us know about that).
>>
>> I'll now work on:
> http://trac.osgeo.org/grass/wiki/Submitting/Python
> http://trac.osgeo.org/grass/wiki/Submitting/wxGUI
>
> I think that we should avoid duplication between C, Python and wxGUI.
> There is a lot of general notes about SVN etc. One thing is maintenance but
> in this case what more important is a developer reading through these files
> and reading something about svn properties over and over again. So I would
> vote for creation of
>
> http://trac.osgeo.org/grass/wiki/Submitting/General
>
> It can be also just in http://trac.osgeo.org/grass/wiki/Submitting/ but
> .../General seems a little bit better for me.
>
>
I have few notes:

svn properties should be solved by svn propset script [1]. The submitting
files can then just contain instructions how to run it.

I think that the formatting should be more in the way of a standard page
with sections and subsections rather than the list. I did this for the
Python and wxGUI pages. It is of course harder to write because you have to
think what should be where and which sections to have but it is more
readable and we don't need the numbered paragraphs/rules.

[1]
http://trac.osgeo.org/grass/browser/grass-addons/tools/module_svn_propset.sh


> Thanks Martin for starting this,
> Vaclav
>
> Thanks, Martin
>>
>> [1] http://trac.osgeo.org/grass/wiki/Submitting/C
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/grass-dev/attachments/20140611/6bfe4f84/attachment.html>