Script to check formatting for GNU style patches

Script to check formatting for GNU style patches

[Sebastian Pop]

[-- Attachment #1: Type: text/plain, Size: 471 bytes --]

Hi,

Some folks complained of not having a script that checks for
formatting issues in the patches to GCC.  The attached script checks
for some common formatting problems that occur in the code of new
contributors to GCC.  With time this script could be improved, but
this is already useful to avoid common mistakes.

I would like to commit this script to the contrib directory.  Ok for trunk?

Thanks,
Sebastian Pop
--
AMD / Open Source Compiler Engineering / GNU Tools

[-- Attachment #2: check_GNU_style.sh --]
[-- Type: application/x-sh, Size: 2382 bytes --]

Re: Script to check formatting for GNU style patches

[Diego Novillo]

On 10-06-30 12:05 , Sebastian Pop wrote:
> Hi,
>
> Some folks complained of not having a script that checks for
> formatting issues in the patches to GCC.  The attached script checks
> for some common formatting problems that occur in the code of new
> contributors to GCC.  With time this script could be improved, but
> this is already useful to avoid common mistakes.
>
> I would like to commit this script to the contrib directory.  Ok for trunk?

OK with a ChangeLog entry.  Thanks for doing this.  I agree that we can 
keep adding to this as we go along.  It does not need to be pretty nor 
perfect to be useful.

In time, we could even add more elaborate checks using something like 
dehydra.

Please wait for Richi to get mem-ref2 merged into trunk before committing.


Diego.

Re: Script to check formatting for GNU style patches

[Manuel López-Ibáñez]

On 30 June 2010 20:30, Diego Novillo <dnovillo@google.com> wrote:
> On 10-06-30 12:05 , Sebastian Pop wrote:
>>
>> Hi,
>>
>> Some folks complained of not having a script that checks for
>> formatting issues in the patches to GCC.  The attached script checks
>> for some common formatting problems that occur in the code of new
>> contributors to GCC.  With time this script could be improved, but
>> this is already useful to avoid common mistakes.
>>
>> I would like to commit this script to the contrib directory.  Ok for
>> trunk?
>
> OK with a ChangeLog entry.  Thanks for doing this.  I agree that we can keep
> adding to this as we go along.  It does not need to be pretty nor perfect to
> be useful.
>

I would humbly suggest to mention this new script in
http://gcc.gnu.org/contribute.html#standards

I would go as far as to add a direct link to the file in trunk.

Manuel.

Re: Script to check formatting for GNU style patches

[Sebastian Pop]

On Wed, Jun 30, 2010 at 14:02, Manuel López-Ibáñez
<lopezibanez@gmail.com> wrote:
> On 30 June 2010 20:30, Diego Novillo <dnovillo@google.com> wrote:
>> On 10-06-30 12:05 , Sebastian Pop wrote:
>>>
>>> Hi,
>>>
>>> Some folks complained of not having a script that checks for
>>> formatting issues in the patches to GCC.  The attached script checks
>>> for some common formatting problems that occur in the code of new
>>> contributors to GCC.  With time this script could be improved, but
>>> this is already useful to avoid common mistakes.
>>>
>>> I would like to commit this script to the contrib directory.  Ok for
>>> trunk?
>>
>> OK with a ChangeLog entry.  Thanks for doing this.  I agree that we can keep
>> adding to this as we go along.  It does not need to be pretty nor perfect to
>> be useful.
>>
>
> I would humbly suggest to mention this new script in
> http://gcc.gnu.org/contribute.html#standards
>
> I would go as far as to add a direct link to the file in trunk.
>

Gerald, does this patch look good?  Ok to apply after the
script is committed to trunk?

Thanks,
Sebastian

*** contribute.html.~1.73.~	2010-03-31 15:08:49.000000000 -0500
--- contribute.html	2010-06-30 15:05:24.000000000 -0500
***************
*** 67,73 ****
  well as requirements on code formatting.</p>

  <p>Submissions which do not conform to the standards will be returned
! with a request to address any such problems.</p>

  <!-- also referenced from svnwrite.html -->
  <h2><a name="testing">Testing Patches</a></h2>
--- 67,77 ----
  well as requirements on code formatting.</p>

  <p>Submissions which do not conform to the standards will be returned
! with a request to address any such problems.  To help with the
! preparation of patches respecting these rules, one can use the script
! <a href="http://gcc.gnu.org/viewcvs/trunk/contrib/check_GNU_style.sh">
! contrib/check_GNU_style.sh</a> to detect some of the common
! mistakes. </p>

  <!-- also referenced from svnwrite.html -->
  <h2><a name="testing">Testing Patches</a></h2>