[Piglit] [PATCH] update the HACKING file's Coding style section

[Dylan Baker]

Could you add a note about python code?

Just something like: "All python code should conform to python's PEP8
standard, using only spaces and no tabs" would be great.


On Fri, Nov 1, 2013 at 1:50 PM, Paul Berry <stereotype441 at gmail.com> wrote:

> On 1 November 2013 08:14, Brian Paul <brianp at vmware.com> wrote:
>
>> I've tried to describe Piglit's coding style and conventions in more
>> detail.  Hopefully, new contributors will read this and it'll save
>> some some time and effort for the reviewers.
>>
>> Please feel free to add/update this info.
>>
>
> Reviewed-by: Paul Berry <stereotype441 at gmail.com>
>
>
>> ---
>>  HACKING |   57 ++++++++++++++++++++++++++++++++++++++++++++-------------
>>  1 file changed, 44 insertions(+), 13 deletions(-)
>>
>> diff --git a/HACKING b/HACKING
>> index a227fc6..03519e5 100644
>> --- a/HACKING
>> +++ b/HACKING
>> @@ -63,25 +63,56 @@ entirely new project. The most important reasons are:
>>
>>
>>
>> +\ Coding style
>> + -------------
>>
>> -\ Ugly Things (or: Coding style)
>> - -------------------------------
>> +Basic formatting:
>>
>> -As a rule of thumb, coding style should be preserved in test code taken
>> from
>> -other projects, as long as that code is self-contained.
>> +* Indent with 8-column tabs
>> +* Limit lines to 78 characters or less
>> +* Function return type and name go on successive lines
>> +* Opening function brace goes on line by itself
>> +* Opening statement braces go on same line as the 'for' or 'else'
>>
>> -Apart from that, the following rules are cast in stone:
>> +The following indent command will generally format your code for piglit's
>> +style:
>>
>> -1. Use tabulators for indentation
>> -2. Use spaces for alignment
>> -3. No whitespace at the end of a line
>> +  indent -br -i8 -npcs -ce input.c -o output.c
>>
>> -See http://electroly.com/mt/archives/000002.html for a well-written
>> rationale.
>> +Though, that doesn't give perfect results.  It messes up the
>> +PIGLIT_GL_TEST_CONFIG_BEGIN/END section.  And array initializers
>> sometimes
>> +come out funny.
>>
>> -Use whatever tabulator size you want:
>> -If you adhere to the rules above, the tab size does not matter. Tab size
>> 4
>> -is recommended because it keeps the line lengths reasonable, but in the
>> end,
>> -that's purely a matter of personal taste.
>> +When in doubt see other recently added piglit tests for coding style.
>> +
>> +
>> +Code conventions:
>> +
>> +* Use "const" qualifiers whenever possible on array declarations,
>> pointers
>> +  and global variables.
>> +* Use "static const" for initialized arrays whenever possible.
>> +* Preprocessor macros should be UPPER_CASE
>> +* Enumeration tokens should be UPPER_CASE
>> +* Most other identifiers are lower_case_with_underscores
>> +* Use int, float, bool except when GL types (GLint, GLfloat) are really
>> needed
>> +* Don't put declarations after code.  For example:
>> +      if (x < 3)
>> +         x = 0;
>> +      int y = x * x;
>> +  This will not compile with MSVC.  The 'int y' declaration must be at
>> the
>> +  top of the brace-block.
>> +* Don't use named/designated initializers.  They don't compile with MSVC.
>> +* Write tests that are easily read, understood and debugged.  Long,
>> complicated
>> +  functions are frowned upon.
>> +* Don't try to test too much in a single test program.  Most piglit
>> programs
>> +  are less than 300 lines long.
>> +
>> +
>> +Utility code:
>> +
>> +Piglit has a rich set of utility functions for basic drawing, setting
>> +up shaders, probing pixels, error checking, etc.  Try to use them before
>> +rolling your own.
>>
>>
>>
>> --
>> 1.7.10.4
>>
>> _______________________________________________
>> Piglit mailing list
>> Piglit at lists.freedesktop.org
>> http://lists.freedesktop.org/mailman/listinfo/piglit
>>
>
>
> _______________________________________________
> Piglit mailing list
> Piglit at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/piglit
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/piglit/attachments/20131102/ac99ad6e/attachment.html>