[Insight-developers] New commit type: "DOC" for documentation

[Bill Lorensen]

Niels,

It was a good idea and somehow got forgotten by us in the bug tracker.

Thanks for your suggestion,

Bill

On Mon, Sep 21, 2009 at 11:32 AM, Niels Dekker <niels-xtk at xs4all.nl> wrote:
> Last Saturday, Bill Lorensen has added a new CVS commit type, "DOC", to the
> exisiting list of commit types ("ENH", "BUG", "STYLE", "COMP", "PERF").
>  According to a request of mine:
> http://public.kitware.com/Bug/view.php?id=7240  Thanks, Bill!
>
> My idea is to use "DOC" only for commits that are strictly limited to
> documentation (typically explanatory comments, ignored by the compiler).
> While a STYLE commit might accidentally cause a (minor) change of behavior
> (you know, bad things happen), a true DOC commit can't possibly do so,
> because it doesn't change anything to the programming logic. So when looking
> for the introduction of a bug or other behavioral change in CVS history,
> commits that are labeled "DOC" should be ignorable.
>
> I have only committed very little to ITK so far, so I just hope you all like
> the intention behind "DOC".
>
> Kind regards, Niels
> --
> Niels Dekker
> http://www.xs4all.nl/~nd/dekkerware
> Scientific programmer at LKEB, Leiden University Medical Center
>
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Please keep messages on-topic and check the ITK FAQ at:
> http://www.itk.org/Wiki/ITK_FAQ
>
> Follow this link to subscribe/unsubscribe:
> http://www.itk.org/mailman/listinfo/insight-developers
>