Revision: 1991 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1991&view=re... Author: colombanw Date: 2011-03-14 19:11:35 +0000 (Mon, 14 Mar 2011)
Log Message: ----------- Add a HACKING with a few information for plugin developers
Modified Paths: -------------- trunk/geany-plugins/README
Added Paths: ----------- trunk/geany-plugins/HACKING
Added: trunk/geany-plugins/HACKING =================================================================== --- trunk/geany-plugins/HACKING (rev 0) +++ trunk/geany-plugins/HACKING 2011-03-14 19:11:35 UTC (rev 1991) @@ -0,0 +1,35 @@ +======================== +Hacking on Geany-Plugins +======================== +.. contents:: + +General +======= + +About this file +--------------- +This file contains some useful information for any plugin developer, and +especially for new plugin developers. + +Building your plugin +-------------------- +You should first read either `README` or `README.waf` depending on whether +you want to use Autotools or Waf to build the plugins. + +Autotools Build System +^^^^^^^^^^^^^^^^^^^^^^ +The Autotools build system automatically enables some code checking +utilities, meant to ease tracking of common programming mistakes, or simply +to help making everyone's plugin code better. +They currently are: + +* C compiler warnings (can be disabled with the ``--disable-extra-c-warnings`` + configuration flag) -- this test is (obviouly) run during build; +* Static code analysis using ``cppcheck`` (can be disabled with the + ``--disable-cppcheck`` configuration flag) -- this test is run during + ``make check``. + +These features are only here to help you writing better code: they are not +necessarily and always right -- though they try. +If you think they reports wrong problems, please file a report on the +appropriate place (either the mailing lists or the geany-plugins bug tracker).
Modified: trunk/geany-plugins/README =================================================================== --- trunk/geany-plugins/README 2011-03-14 19:11:16 UTC (rev 1990) +++ trunk/geany-plugins/README 2011-03-14 19:11:35 UTC (rev 1991) @@ -60,6 +60,8 @@ * tableconvert -- the Tableconvert plugin * updatechecker -- the Updatechecker plugin * webhelper -- the WebHelper plugin +* extra-c-warnings -- extra C Compiler warnings (see also HACKING) +* cppcheck -- static code analysis using cppcheck (see also HACKING)
Example: ./configure --enable-geanylua --enable-spellcheck
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.