Some stylistic notes
Thanks to everybody for improving the AVRDUDE code base. I see
there were a number of commits within the past months.
I'm not very religious about stylistic issues. After all, I basically
"inherited" the maintenance of that project from Brian Dean, and a lot
of the code present in AVRDUDE today has been contributed by a large
number of people in the past, so the overall style is not very
uniform. Just a few things I'm asking for.
For new files, please take care to have at least the svn:eol-style
set to native, and svn:keywords to (at least) Id. Add $Id$
lines to each file so the file's version can be tracked "in the
field". Preferrably, do also set svn:mime-type (usually to
text/plain). The easiest way to do this is to activate the line
enable-auto-props = yes
in your ~/.subversion/config file (or wherever this file lives in
your environment), and add suitable auto-props patterns. For
reference, I'm appending the patterns I've been collecting in my SVN
era so far below.
- If possible, avoid non-ASCII characters (there have been a few UTF-8
long dashes in some file, where simple ASCII dashes would do fine).
- When using hard TABs, the remainder of the AVRDUDE code uses them
with a tab stop each 8 columns, as is the historical DEC VTxx (and
Unix) standard. If you don't like this, then better don't use TABs
but simple spaces everywhere.
- Try avoiding trailing white space behind the printable characters of
each line (even though the historic AVRDUDE code suffers a lot from
that still, and I hesitate to force commits for code that has
otherwise not been touched sometimes for years).
Back to Developers' Corner.
Last modified: Fri Jan 8 09:23:44 CET 2010