ITK Procedure for Checking Style: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
Line 6: Line 6:




* Download KWStyle from http://public.kitware.com/KWStyle/download.htm
* Download KWStyle:
<pre>
cvs -d:pserver:anoncvs@www.itk.org:/cvsroot/KWStyle login
<CR>
cvs -d:pserver:anoncvs@www.itk.org:/cvsroot/KWStyle co KWStyle
</pre>


== Building KWStyle ==
== Building KWStyle ==

Revision as of 21:20, 9 December 2008

Get KWStyle

Downloading KWStyle

  • Download KWStyle:
cvs -d:pserver:anoncvs@www.itk.org:/cvsroot/KWStyle login
<CR>
cvs -d:pserver:anoncvs@www.itk.org:/cvsroot/KWStyle co KWStyle

Building KWStyle

  • Configure with CMake
  • Build with your compiler

Configure your ITK Build

  • Rerun CMake on you ITK Binary builds

Point to your KWStyle executable

  • Provide the path to your KWStyle executable

Select error format

  • The options are
    • Formatting for VIM (the best editor)
    • Formatting for Visual Studio (if you are a Windows victim)

Running KWStyle

From the command line

Use the following command

  KWStyle -v  -xml  ITK_BINARY_DIR/ITK.kws.xml  -o ITK_SOURCE_DIR/Utilities/KWStyle/ITKOverwrite.txt  filename

Where

  • -v : stands for Verbose
  • -xml : is the file containing the description of the coding style in XML
  • -o : is the file that contains exceptions to the kwstyle rules
  • ITK_BINARY_DIR : should be replaced with the path to the binary directory where you build ITK
  • ITK_SOURCE_DIR : should be replaced with the path to the source irectory of ITK
  • filename : is the name of the file for which you are currently checking coding style