Development/Tutorials/Code Checking - Revision history

Sheedy: /* Controlling Krazy on the EBN */ Wiki no more exist, and empty on community.kde.org

2012-12-02T03:00:39Z

‎Controlling Krazy on the EBN: Wiki no more exist, and empty on community.kde.org

AnneW at 15:19, 13 July 2012

2012-07-13T15:19:12Z

Icwiener: Fix syntax highlighting.

2011-06-27T14:28:45Z

Fix syntax highlighting.

Show changes

Camilasan at 15:20, 19 January 2011

2011-01-19T15:20:09Z

Mghansen256: Update SVN links to gitorious.org links.

2011-01-02T10:48:45Z

Update SVN links to gitorious.org links.

Lliehu: Added info for Module=qclasses

2010-03-23T21:26:45Z

Added info for Module=qclasses

Odysseus: /* Module=includes */

2009-12-07T19:17:54Z

‎Module=includes

Odysseus: /* Krazy Modules */

2009-12-02T19:09:03Z

‎Krazy Modules

Odysseus: /* Module=foreach */

2009-12-02T19:06:39Z

‎Module=foreach

Odysseus: /* Module=foreach */

2009-12-02T19:04:57Z

‎Module=foreach

@@ Line 137: / Line 137: @@
 </pre>
-{{Note|Individual modules can be ignored as well, but this is an EBN administrator duty controlled by component-level ''.krazy'' files within the ''/usr/local/src'' hierarchy. See the [http://wiki.kde.org/English+Breakfast+Network English Breakfast Network wiki] for details.}}
+{{Note|Individual modules can be ignored as well, but this is an EBN administrator duty controlled by component-level ''.krazy'' files within the ''/usr/local/src'' hierarchy.}}
 ===Krazy Modules===

← Older revision		Revision as of 15:19, 13 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Code Checking}}~~
−
−
	==Code Checking==		==Code Checking==
	There are a lot of ways to find bugs in KDE code. Increasingly, KDE developers have started to use automated tools. You can use some of those tools to improve your own code.		There are a lot of ways to find bugs in KDE code. Increasingly, KDE developers have started to use automated tools. You can use some of those tools to improve your own code.

← Older revision		Revision as of 15:20, 19 January 2011
Line 1:		Line 1:
		+	{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Code Checking}}
		+
		+
	==Code Checking==		==Code Checking==
	There are a lot of ways to find bugs in KDE code. Increasingly, KDE developers have started to use automated tools. You can use some of those tools to improve your own code.		There are a lot of ways to find bugs in KDE code. Increasingly, KDE developers have started to use automated tools. You can use some of those tools to improve your own code.

@@ Line 6: / Line 6: @@
 You can also run the tests yourself. To do this, you need to obtain a copy of
-the code from {{path|trunk/quality/krazy2}} and install them. You can then test either a single file (using the krazy2 application) or a whole tree, including subdirectories (using the krazy2all application).
+the code from [http://gitorious.org/krazy/krazy/trees/master krazy2/install.txt] and install them. You can then test either a single file (using the krazy2 application) or a whole tree, including subdirectories (using the krazy2all application).
 ====How Krazy works====
@@ Line 23: / Line 23: @@
 Krazy needs to be installed before use. Krazy has two different ways to be
 installed - you can either modify the {{path|krazy2/install.sh}} script and
-run it, or follow the instructions in the [http://websvn.kde.org/trunk/quality/krazy2/INSTALL.txt?view=markup krazy2/INSTALL.txt] file. I recommend the second.
+run it, or follow the instructions in the [http://gitorious.org/krazy/krazy/trees/master krazy2/install.txt] file. I recommend the second.
 You may need to install additional perl modules like XML::LibXML, here is how:
@@ Line 85: / Line 85: @@
 To exclude a particular plugin from being run on a line of code, simply add
 a C++ comment containing the string "krazy:exclude=<plugin_name>". The plugins currently available can be found in the
-[http://websvn.kde.org/trunk/quality/krazy2/plugins repository].
+[http://gitorious.org/krazy/krazy/trees/master repository].
 Specifically, for this plugin use "krazy:exclude=doublequote_chars".

@@ Line 331: / Line 331: @@
 <code>
 // krazy:exclude=includes
 </code>
 ==Compiler Warnings==
 In addition to the various Krazy tools, you can also get valuable assistance from the warnings that the compiler emits, especially if you enable additional warnings (per the documentation for your compiler), and also if you test with more than one compiler (e.g. if you can test on Linux with both GCC and the Intel compiler; or on Linux with GCC and also on Windows with the Microsoft compiler).

@@ Line 309: / Line 309: @@
 The cpp file should include their own .h and _p.h headers first in the file (but below config.h).  Move the includes to the correct position.  You may need to adjust includes and forward declarations in other files as a result, the compiler will advise of these.
-Use <..> to include installed headers.
+'''Message:''' missing or improper include guard in header
-To include Qt headers from installed headers.
+'''Risk from Fixing:''' Low
-Use include guards in headers with appropriately encoded macro names.
+Either the include guards are missing, or they are not appropriately encoded macro names, e.g. do not include the class name.
 To exclude all checks in file comment at top of file:

← Older revision		Revision as of 19:09, 2 December 2009
Line 144:		Line 144:

	'''High:''' Should only be fixed by maintainer/owner of code		'''High:''' Should only be fixed by maintainer/owner of code
		+
		+	If you don't understand the code, or you don't understand the fix, then do not fix the code.
		+
		+	Fixing apidox and spelling mistakes only requires a compile before submitting. All other fixes should be tested to an appropriate degree, the standard unit tests are useful for this.

	====Module=spelling====		====Module=spelling====

@@ Line 229: / Line 229: @@
 When not using POD types (int, double, pointer, ...) you should use const & for your foreach variables. There are two reasons for this: 1) Prevents you from the mistake of writing foreach loops that modify the list, that is 'foreach(Foo f, list) f.a = f.b = f.c = 0;' compiles but does not modify the contents of list 2) Saves a copy constructor call for each of the list elements
-Be careful if dealing with pointers?  False positive for bool and qlonglong?
+Be careful if dealing with pointers?  False positive for bool, qlonglong and qulonglong?
 http://tsdgeos.blogspot.com/2008/04/qforeach-is-your-friend.html