BIND 10 trac3109, updated. 8ce7f740b84364774d90f3438634577cc556ae66 [3109] Extra details added to Contributor's Guidelines

BIND 10 source code commits bind10-changes at lists.isc.org
Tue Sep 3 14:00:59 UTC 2013 

The branch, trac3109 has been updated
       via  8ce7f740b84364774d90f3438634577cc556ae66 (commit)
      from  9b5c746e9bf6fe264f4aa57dc0e884f4fd5a8d85 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 8ce7f740b84364774d90f3438634577cc556ae66
Author: Tomek Mrugalski <tomasz at isc.org>
Date:   Tue Sep 3 16:00:00 2013 +0200

    [3109] Extra details added to Contributor's Guidelines

-----------------------------------------------------------------------

Summary of changes:
 doc/devel/contribute.dox |   53 +++++++++++++++++++++++++++++++++++++++++-----
 doc/devel/mainpage.dox   |    5 +++--
 2 files changed, 51 insertions(+), 7 deletions(-)

-----------------------------------------------------------------------
diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox
index 17dbf0b..f5f3e24 100644
--- a/doc/devel/contribute.dox
+++ b/doc/devel/contribute.dox
@@ -16,16 +16,18 @@
 
  @page contributorGuide BIND10 Contributor's Guide
 
-So you found a bug in BIND10 or developed an extension and want to
+So you found a bug in BIND10 or plan to develop an extension and want to
 send a patch? Great! This page will explain how to contribute your
 changes and not get disappointed in the process.
 
+ at section contributorGuideWritePatch Writing a patch
+
 Before you start working on a patch or new feature, it is a good idea
 to discuss it first with BIND10 developers. You can post your
 questions to bind10-dev
 (https://lists.isc.org/mailman/listinfo/bind10-dev) for general BIND10
 stuff or to bind10-dhcp
-(https://lists.isc.org/mailman/listinfo/bind10-dhcp) for DHCP specific
+(https://lists.isc.org/mailman/listinfo/bind10-dhcp) mailing lists for DHCP specific
 topics. If you prefer to get faster feedback, most BIND10 developers
 hang out at bind10 jabber room
 (xmpp:bind10 at conference.jabber.isc.org). Those involved in DHCP also
@@ -35,6 +37,11 @@ specific issue or perhaps the solution you plan to implement is not
 the best one. Often having 10 minutes talk could save many hours of
 engineering work.
 
+First step would be to get a source code from our GIT repository. The procedure
+is very easy and is explained here: http://bind10.isc.org/wiki/GitGuidelines.
+While it is possible to provide a patch against stable release, it makes
+the review process much easier if it is for latest code grom a git 'master' branch.
+
 Ok, so you have a patch? Great! Before you submit it, make sure that
 your code compiles. This may seem obvious, but it there's more to
 it. I'm sure you have checked that it compiles on your system, but
@@ -44,7 +51,7 @@ code compile there? Will it work? What about endianess? It is likely
 that you used regular x86, but the software is expected to run on many
 other architectures.
 
-Have your patch conforms to BIND10 
+Does your patch conforms to BIND10
 http://bind10.isc.org/wiki/CodingGuidelines? You still can submit
 a patch that does not adhere to it, but it will decrease your
 chances of being accepted. If the deviations are minor, ISC engineer
@@ -52,35 +59,60 @@ that will do the review, will likely fix the issues. However,
 if there are lots of them, reviewer may simply reject the patch
 and ask you to fix it, before resubmitting.
 
+ at section contributorGuideUnittests Running unit-tests
+
 One of the ground rules in BIND10 development is that every piece of
 code has to be tested. We now have an extensive set of unit-tests for
 almost every line of code. Even if you are fixing something small,
 like a single line fix, it is encouraged to write unit-test for that
 change. That is even more true for new code. If you write a new
 function, method or a class, you definitely should write unit-tests
-for it. 
+for it.
 
 BIND10 uses google test (gtest) framework as a base for our
 unit-tests. See http://code.google.com/p/googletest/ for details.
 You must have gtest installed or at least compiled before compiling
 BIND10 unit-tests. To enable unit-tests in BIND10
 
+ at code
 ./configure --with-gtest=/path/to/your/gtest/dir
+ at endcode
 
-or 
+or
 
+ at code
 ./configure --with-gtest-source=/path/to/your/gtest/dir
+ at endcode
+
+There are other useful switches passed to configure. It is always a good
+idea to use --enable-logger-checks, which does sanity checks on logger
+parameters. If you happen to modify anything in the documentation, use
+--enable-generate-docs. If you are modifying DHCP code, you are likely
+to be interested in MySQL backend for DHCP. Keep note that if the backend
+is not enabled, MySQL specific unit-tests are skipped, too. From that
+perspective, it is useful to use --with-dhcp-mysql parameter. For a
+complete list of all switches, use:
+
+ at code
+ ./configure --help
+ at endcode
 
 Depending on how you compiled or installed (e.g. from sources or using
 some package management system) one of those two switches will find
 gtest. After that you make run unit-tests:
 
+ at code
 make check
+ at endcode
 
 If you happen to add new files or modified Makefiles, it is also a
 good idea to check if you haven't broken distribution process:
 
+ at code
 make distcheck
+ at endcode
+
+ at section contributorGuideReview Going through a review
 
 Once all those are checked and working, feel free to create a ticket
 for your patch (http://bind10.isc.org) or attach your patch to the
@@ -106,4 +138,15 @@ will add a note to ChangeLog. If the contributted feature is big or
 critical for whatever reason, it may be also mentioned in release
 notes.
 
+ at section contributorGuideExtra Extra steps
+
+If you are interested in even more in-depth testing, you are welcome
+to visit BIND10 build farm: http://git.bind10.isc.org/~tester/builder/builder-new.html
+This is a life result page with all tests being run on various systems.
+Besides basic unit-tests, we also run them with valgrind (memory debugger),
+with cppcheck and scan-build (static code analyzers), Lettuce system tests
+and more. Although it is not possible for non ISC employees to run tests
+on that farm, it is possible that your contributed patch will end up there
+sooner or later.
+
 */
\ No newline at end of file
diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox
index 6335264..17059f6 100644
--- a/doc/devel/mainpage.dox
+++ b/doc/devel/mainpage.dox
@@ -33,11 +33,12 @@
  * you should read <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10
  * Guide (Administrator Reference for BIND10)</a> instead.
  *
+ * Regardless of your field of expertise, you are encouraged to visit
+ * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
+ *
  * @section contrib Contributor's Guide
  * - @subpage contributorGuide
  *
- * Regardless of your field of expertise, you are encouraged to visit
- * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
  * @section hooksFramework Hooks Framework
  * - @subpage hooksdgDevelopersGuide
  * - @subpage dhcpv4Hooks

More information about the bind10-changes mailing list