[Insight-developers] Problems with Style Check, preventing commit

[Luis Ibanez]

Hi Brad,

Our coding style requires variables to be
named with Capital letters as initials.

This is defined in:

   Insight/Utilities/KWStyle/
                                ITK.kws.xml.in

In line 5:

5:<Typedefs>[A-Z]</Typedefs>


The two possible solutions are:

A) Rename the types to something like


      typedef ::int8_t   Int8_t;

or

B) Exclude your file from being checked
    for typedef style.
    This can be done in:

   Insight/Utilities/KWStyle/
                                ITKOverwrite.txt

       You will find that the exclusion
       has already been made for many
       other files.

        see for example, line 75.



You can avoid this commit surprises if you
build KWStyle locally, enable KWStyle
checking in ITK (with CMake), and run the
StyleCheck before you attempt to commit.


      Luis


----------------------------------------------------
On Mon, Dec 14, 2009 at 12:25 PM, Bradley Lowekamp
<blowekamp at mail.nih.gov> wrote:
> Hello,
> I am trying to commit the file attached to this bug:
> http://www.itk.org/Bug/view.php?id=9426
> When I try to check in the file I get the following message:
>
> Message: cvs [commit aborted]: correct above errors first!
> Message: Committer: Bradley Lowekamp <blowekamp at mail.nih.gov>
> Message: Committer: Bradley Lowekamp <blowekamp at mail.nih.gov>
> Message: Running style check
> Message: Running style check
> Message: Processing itkMersenneTwisterRandomVariateGenerator.h
> Message:
> Message:
> Message:
> Message: Running style check
> Message: Processing itkIntTypes.h
> Message: Error #15 (83) Type definition (int8_t) doesn't match regular
> expression
> Message: Error #15 (84) Type definition (uint8_t) doesn't match regular
> expression
> Message: Error #15 (85) Type definition (int16_t) doesn't match regular
> expression
> Message: Error #15 (86) Type definition (uint16_t) doesn't match regular
> expression
> Message: Error #15 (87) Type definition (int32_t) doesn't match regular
> expression
> Message: Error #15 (88) Type definition (uint32_t) doesn't match regular
> expression
> Message: Error #15 (89) Type definition (int64_t) doesn't match regular
> expression
> Message: Error #15 (90) Type definition (uint64_t) doesn't match regular
> expression
> Message: Error #15 (95) Type definition (int_least8_t) doesn't match regular
> expression
> Message: Error #15 (96) Type definition (uint_least8_t) doesn't match
> regular expression
> Message: Error #15 (97) Type definition (int_least16_t) doesn't match
> regular expression
>
> The typedefs look like:
> typedef ::int8_t   int8_t;
> typedef ::uint8_t  uint8_t;
> typedef ::int16_t  int16_t;
> typedef ::uint16_t uint16_t;
> typedef ::int32_t  int32_t;
> typedef ::uint32_t uint32_t;
> typedef ::int64_t  int64_t;
> typedef ::uint64_t uint64_t;
> I don't understand the error message or what to do to check in the code. Is
> this a KWStyle issue?
>
> Thanks,
>  Brad
> Note if some one does forceable try to check in the file then this one
> additional change to occur at the same time:
> --- Code/Common/itkMersenneTwisterRandomVariateGenerator.h 8 Aug 2009
> 15:25:34 -0000 1.9
> +++ Code/Common/itkMersenneTwisterRandomVariateGenerator.h 14 Dec 2009
> 17:14:25 -0000
> @@ -111,7 +111,7 @@
>    typedef SmartPointer<Self>                    Pointer;
>    typedef SmartPointer<const Self>              ConstPointer;
>
> -  typedef ITK_UINT32 IntegerType;
> +  typedef uint32_t IntegerType;
>
>    /** Run-time type information (and related methods). */
>    itkTypeMacro(MersenneTwisterRandomVariateGenerator,
>
>
> ========================================================
>
> Bradley Lowekamp
>
> Lockheed Martin Contractor for
>
> Office of High Performance Computing and Communications
>
> National Library of Medicine
>
> blowekamp at mail.nih.gov
>
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Kitware offers ITK Training Courses, for more information visit:
> http://kitware.com/products/protraining.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
>
>