<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
<title></title>
</head>
<body bgcolor="#ffffff" text="#000000">
Andrew<br>
<blockquote cite="mid021501c65125$1bcbaad0$c5d24e81@acfr.usyd.edu.au"
type="cite">
<div class="Section1">
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;">John, I
don’t like the idea.</span></font></p>
</div>
</blockquote>
Well that's not good enough (for me). I don't like many things, but
they are not policy because of it.(eg having all the parametric sources
in Common strikes me as wrong, but they are still there).<br>
<blockquote cite="mid021501c65125$1bcbaad0$c5d24e81@acfr.usyd.edu.au"
type="cite">
<div class="Section1">
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;">I realize it
is an effort to convert to
the VTK coding style, but I think that coding styles should be
consistent
throughout a library. Otherwise it gets difficult to read code as you
constantly have to switch styles. It also increases the possibility of
missing subtle
errors.</span></font></p>
</div>
</blockquote>
I disagree. I have worked with C/C++ for many years and so have all the
vtk developers. They can cope with different styles (and so can I, but
I'd rather work with mine). I am only asking for the right to
contribute complete modules in my style. I will not alter any existing
classes to a new style.<br>
<blockquote cite="mid021501c65125$1bcbaad0$c5d24e81@acfr.usyd.edu.au"
type="cite">
<div class="Section1">
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"><o:p></o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"><o:p> </o:p><br>
Surely it is not that much effort to fit
in with the VTK style. With modern text editors it should be simple to
reformat. I think someone at VTK has some scripts for this … but I may
be
wrong. I know there is an EMACS thingie for VTK formatting floating
around
somewhere.</span></font></p>
</div>
</blockquote>
It's not about difficulty in converting the code. Its about
maintenance. I will be able to debug faster if the code is in my
format. I have had a lot of emails about the netCDF reader and none of
them complained about the coding style. <font color="#ff0000">The
Style is really not that important to most people</font>.<br>
<blockquote cite="mid021501c65125$1bcbaad0$c5d24e81@acfr.usyd.edu.au"
type="cite">
<div class="Section1">
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"><o:p></o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;">I don’t use
their style either and
for the vtkParametric functions I had to convert to their style. It
took a bit
of time but it also had the advantage that when doing it I had to read
the code
and fixed up a few oddities etc. in the code</span></font></p>
</div>
</blockquote>
I have looked at every single cvs log message for all the Parametric
sources. Apart from<br>
1) Moving to common by Will<br>
2) A style change by Matthieu (capitalization)<br>
there is only one commit by anyone other than you (it was Will) which
contained a substantial change to the code - and in that case it was a
change of base class on (I think) one file.<br>
<br>
You are the only one who maintains these classes - and I will probably
be the one who maintains my classes. I would like to work with my code
not a version of my code that has been mangled up. <font
color="#ff0000">It will make no difference to anybody at all <font
color="#000000">if I use my style on my classes, and therefore it is
not worth enforcing it. The bad side is that I'll just continue doing
what I'm doing now and not contribute anything new because I feel very
strongly about it and I would rather keep the code the way I like it.<br>
<br>
JB<br>
</font></font>
<blockquote cite="mid021501c65125$1bcbaad0$c5d24e81@acfr.usyd.edu.au"
type="cite">
<div class="Section1">
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"><o:p></o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"><o:p> </o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;">Regards<o:p></o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"> Andrew<o:p></o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"><o:p> </o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"> <o:p></o:p></span></font></p>
<p class="MsoNormal"><font color="navy" face="Arial" size="2"><span
style="font-size: 10pt; font-family: Arial; color: navy;"><o:p> </o:p></span></font></p>
<div>
<div class="MsoNormal" style="text-align: center;" align="center"><font
color="black" face="Times New Roman" size="3"><span
style="font-size: 12pt; color: windowtext;">
<hr tabindex="-1" align="center" size="3" width="100%"></span></font></div>
<p class="MsoNormal"><b><font color="black" face="Tahoma" size="2"><span
style="font-size: 10pt; font-family: Tahoma; color: windowtext; font-weight: bold;">From:</span></font></b><font
color="black" face="Tahoma" size="2"><span
style="font-size: 10pt; font-family: Tahoma; color: windowtext;">
<a class="moz-txt-link-abbreviated" href="mailto:vtk-developers-bounces+andrew.amaclean=gmail.com@vtk.org">vtk-developers-bounces+andrew.amaclean=gmail.com@vtk.org</a>
[<a class="moz-txt-link-freetext" href="mailto:vtk-developers-bounces+andrew.amaclean=gmail.com@vtk.org">mailto:vtk-developers-bounces+andrew.amaclean=gmail.com@vtk.org</a>] <b><span
style="font-weight: bold;">On Behalf Of </span></b>John Biddiscombe<br>
<b><span style="font-weight: bold;">Sent:</span></b> Sunday, 26 March
2006 05:37<br>
<b><span style="font-weight: bold;">To:</span></b> vtk-developers<br>
<b><span style="font-weight: bold;">Subject:</span></b>
[vtk-developers] vtk
Coding style : Proposed change</span></font><font color="black"><span
style="color: windowtext;"><o:p></o:p></span></font></p>
</div>
<p class="MsoNormal"><font color="black" face="Times New Roman"
size="3"><span style="font-size: 12pt;"><o:p> </o:p></span></font></p>
<p class="MsoNormal"><font color="black" face="Times New Roman"
size="3"><span style="font-size: 12pt;">Dear vtk developers,<br>
<br>
I have a number of modules that I would like to (and have been asked
to)
contribute in the near to mid-term future but I do not wish to reformat
my code
to fit the vtk coding style. If (for example) vtkNetCDFReader is
contributed to
vtk/paraview, I will most likely be doing the majority of maintenance
and
fixing work on the class(es). I do not like the vtk coding style as I
find it
hard to quickly mentally parse (bracket indentation in particular) and
I would
like to reserve the right to use my own coding style on the contributed
class(es). I can digest and debug my own code considerably faster
because I am
familiar with the way it is structured and laid out.<br>
<br>
I would like therefore to propose that the vtk coding style (as
described here <a href="http://www.vtk.org/Wiki/VTK_Coding_Standards">http://www.vtk.org/Wiki/VTK_Coding_Standards</a>
) be modified to include the following (additional text in red -
apologies for
non html capable email readers)<o:p></o:p></span></font></p>
<ul type="disc">
<li class="MsoNormal" style=""><font color="black"
face="Times New Roman" size="3"><span style="font-size: 12pt;">The
indentation style can be characterized as the "indented brace" style.
Indentations are two spaces, and the curly brace (scope delimiter) is
placed on the following line and indented along with the code (i.e.,
the curly brace lines up with the code). Example: <o:p></o:p></span></font></li>
</ul>
<pre><font color="black" face="Courier New" size="2"><span
style="font-size: 10pt;"> [example deleted]<o:p></o:p></span></font></pre>
<ul type="disc">
<li class="MsoNormal" style=""><font color="red"
face="Times New Roman" size="3"><span
style="font-size: 12pt; color: red;">Code contributions/modifications
should use the accepted vtk coding style as outlined in this document,
with the exception that contributions which consist of new modules in
their entirety are permitted to use their own style - provided the
style is consistent throughout the whole contributed module.</span></font><o:p></o:p></li>
<li class="MsoNormal" style=""><font color="red"
face="Times New Roman" size="3"><span
style="font-size: 12pt; color: red;">Modifications to existing code
must follow the coding style of the module being changed. If the code
being changed is a contributed module which deviates from the accepted
vtk style then the changes should attempt to follow the contributed
style.</span></font><o:p></o:p></li>
</ul>
<p class="MsoNormal"><font color="black" face="Times New Roman"
size="3"><span style="font-size: 12pt;">To summarize my changes in a
nutshell :<br>
Any fixes/modifications/additions to existing code must
follow the coding style of the module being modified : In the vast
majority of
cases this means that the standard vtk coding style must be used. All
existing
classes must continue to use the vtk coding style. But I (for one)
would like
to be able to contribute new code in my own style and anyone modifying
the code
I have contributed should follow the style I have used in the module as
best
they can.<br>
<br>
If this proposal is accepted, then I will be happy and will (hopefully)
never
need to raise the issue of coding style again. I have asked in the past
to
change the style, but met with opposition, I believe the wording of my
proposition above is flexible enough to satisfy myself and others
without
opening the doors to complete corruption of the existing code-base.
Please feel
free to propose further changes to my text, but do not dismiss out of
hand my
proposition as I believe that the majority of vtk developers are
capable of
coping with different styles providing they are consistent. In general
very few
vtk users (or indeed developers) study the source code in great depth
for
modules other that those that they are making use of heavily, (and have
problems with). I find it acutely painful to reformat code that may be
thousands of lines long into a style that I don't like, for nobody's
benefit.<br>
<br>
NB : One possible addition to my proposal might be that modules
deviating from
the standard vtk style should contain a disclaimer<br>
"This class uses a different coding style to the vtk standard, please
pay
careful attention to code layout when debugging"<br>
<br>
yours<br>
<br>
JB<br>
<br>
<o:p></o:p></span></font></p>
<pre><font color="black" face="Courier New" size="2"><span
style="font-size: 10pt;">-- <o:p></o:p></span></font></pre>
<pre><font color="black" face="Courier New" size="2"><span
style="font-size: 10pt;">John Biddiscombe, <a
href="email:biddisco">email:biddisco</a> @ cscs.ch<o:p></o:p></span></font></pre>
<pre><font color="black" face="Courier New" size="2"><span
style="font-size: 10pt;"><a href="http://www.cscs.ch/about/BJohn.php">http://www.cscs.ch/about/BJohn.php</a><o:p></o:p></span></font></pre>
<pre><font color="black" face="Courier New" size="2"><span
style="font-size: 10pt;">CSCS, Swiss National Supercomputing Centre | Tel: +41 (91) 610.82.07<o:p></o:p></span></font></pre>
<pre><font color="black" face="Courier New" size="2"><span
style="font-size: 10pt;">Via Cantonale, 6928 <st1:place w:st="on"><st1:City
w:st="on">Manno</st1:City>, <st1:country-region w:st="on">Switzerland</st1:country-region></st1:place> | Fax: +41 (91) 610.82.82<o:p></o:p></span></font></pre>
</div>
</blockquote>
<br>
<br>
<pre class="moz-signature" cols="72">--
John Biddiscombe, <a class="moz-txt-link-freetext" href="email:biddisco">email:biddisco</a> @ cscs.ch
<a class="moz-txt-link-freetext" href="http://www.cscs.ch/about/BJohn.php">http://www.cscs.ch/about/BJohn.php</a>
CSCS, Swiss National Supercomputing Centre | Tel: +41 (91) 610.82.07
Via Cantonale, 6928 Manno, Switzerland | Fax: +41 (91) 610.82.82
</pre>
</body>
</html>