[csw-maintainers] GAR coding style

[Dagobert Michelsen]

Hi Maciej,

Am 03.09.2011 um 23:49 schrieb Maciej Bliziński:
> 2011/9/3 Ben Walton <bwalton at opencsw.org>:
>> Excerpts from Maciej Bliziński's message of Sat Sep 03 12:06:33 -0400 2011:
>>> http://sourceforge.net/apps/trac/gar/wiki/GarCodingStyle
>> 
>>> Should we update the coding guideline to reflect this, or do we need
>>> more discussion?
>> 
>> I am in the group that has started lumping package describing things
>> together although I typically still follow the overall flow of the
>> described style.  I think that if #9 were blended into #3 that it
>> would fairly closely match my preferred pattern.  I'd be happy to
>> support this (fairly minor, imo) change.
>> 
>> Do you see larger changes needed to fit what we're seeing in practice?
> 
> Nothing larger, your paragraph summarizes it well.  I'd move PACKAGES
> and SPKG_DESC from #3 to #9, and indicate that PACKAGES would use +=
> and have one entry per package.  I also thought that we could show an
> example, an example may be easier to understand than a description.

This is exactly how I write it now. Additionally, I would recommend not
setting defaults like package catalog name unless it is needed to make
something explicitly clear or change the defaults.


Best regards

  -- Dago