From 9b5c746e9bf6fe264f4aa57dc0e884f4fd5a8d85 Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Tue, 20 Aug 2013 19:03:18 +0200 Subject: [PATCH 01/27] [3109] Initial text import for Contributor's Guide --- doc/devel/contribute.dox | 109 +++++++++++++++++++++++++++++++++++++++ doc/devel/mainpage.dox | 3 ++ 2 files changed, 112 insertions(+) create mode 100644 doc/devel/contribute.dox diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox new file mode 100644 index 0000000000..17dbf0b09d --- /dev/null +++ b/doc/devel/contribute.dox @@ -0,0 +1,109 @@ +// Copyright (C) 2013 Internet Systems Consortium, Inc. ("ISC") +// +// Permission to use, copy, modify, and/or distribute this software for any +// purpose with or without fee is hereby granted, provided that the above +// copyright notice and this permission notice appear in all copies. +// +// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH +// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +// AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, +// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE +// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +// PERFORMANCE OF THIS SOFTWARE. + +/** + + @page contributorGuide BIND10 Contributor's Guide + +So you found a bug in BIND10 or developed 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. + +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 +topics. If you prefer to get faster feedback, most BIND10 developers +hang out at bind10 jabber room +(xmpp:bind10@conference.jabber.isc.org). Those involved in DHCP also +use dhcp chatroom (xmpp:dhcp@conference.jabber.isc.org). Feel free to +drop a note. It is possible that someone else is working on your +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. + +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 +BIND10 is a portable software. Besides Linux, it is being compiled on +relatively uncommon systems, like OpenBSD or Solaris 11. Will your +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 +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 +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. + +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. + +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 + +./configure --with-gtest=/path/to/your/gtest/dir + +or + +./configure --with-gtest-source=/path/to/your/gtest/dir + +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: + +make check + +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: + +make distcheck + +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 +existing ticket if there is one. You may drop a note to bind10 or dhcp +chatroom saying that you have submitted a patch. Alternatively, you +may send a note to bind10-dev or bind10-dhcp lists. + +Here's the tricky part. One of BIND10 developers will review your +patch, but it may not happen immediately. Unfortunately, developers +are usually working under tight schedule, so any extra unplanned +review work sometimes make take a while. Having said that, we value +external contributions very much and will do whatever we can to +review patches in a timely manner. Don't get discouraged if your +patch is not accepted after first review. To keep the code quality +high, we use the same review processes for internal code and for +external patches. It may take several cycles of review/updated patch +submissions before the code is finally accepted. + +Once the process is almost completed, the developer will likely ask +you how you would like to be credited. The typical answers are by +first,last name, by nickname, by company or anonymously. Typically we +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. + +*/ \ No newline at end of file diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox index c670eaf140..6335264096 100644 --- a/doc/devel/mainpage.dox +++ b/doc/devel/mainpage.dox @@ -33,6 +33,9 @@ * you should read BIND10 * Guide (Administrator Reference for BIND10) instead. * + * @section contrib Contributor's Guide + * - @subpage contributorGuide + * * Regardless of your field of expertise, you are encouraged to visit * BIND10 webpage (http://bind10.isc.org) * @section hooksFramework Hooks Framework From 8ce7f740b84364774d90f3438634577cc556ae66 Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Tue, 3 Sep 2013 16:00:00 +0200 Subject: [PATCH 02/27] [3109] Extra details added to Contributor's Guidelines --- 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 17dbf0b09d..f5f3e24416 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. +@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@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. +@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 +@code ./configure --with-gtest=/path/to/your/gtest/dir +@endcode -or +or +@code ./configure --with-gtest-source=/path/to/your/gtest/dir +@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: + +@code + ./configure --help +@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: +@code make check +@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: +@code make distcheck +@endcode + +@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. +@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 6335264096..17059f6bc9 100644 --- a/doc/devel/mainpage.dox +++ b/doc/devel/mainpage.dox @@ -33,11 +33,12 @@ * you should read BIND10 * Guide (Administrator Reference for BIND10) instead. * + * Regardless of your field of expertise, you are encouraged to visit + * BIND10 webpage (http://bind10.isc.org) + * * @section contrib Contributor's Guide * - @subpage contributorGuide * - * Regardless of your field of expertise, you are encouraged to visit - * BIND10 webpage (http://bind10.isc.org) * @section hooksFramework Hooks Framework * - @subpage hooksdgDevelopersGuide * - @subpage dhcpv4Hooks From cfd7033c2710b19d92d719f54ceb50fe866261bc Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:11:48 +0530 Subject: [PATCH 03/27] [3109] Add article and trailing newline --- doc/devel/contribute.dox | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index f5f3e24416..7ff5b9b2e3 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -22,7 +22,7 @@ changes and not get disappointed in the process. @section contributorGuideWritePatch Writing a patch -Before you start working on a patch or new feature, it is a good idea +Before you start working on a patch or a 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 @@ -149,4 +149,4 @@ 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 +*/ From 46e6d05e9f1c6990c17afff7890607db8c5acc04 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:13:18 +0530 Subject: [PATCH 04/27] [3109] Update text for easier reading --- doc/devel/contribute.dox | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 7ff5b9b2e3..55200ebd9b 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -24,10 +24,10 @@ changes and not get disappointed in the process. Before you start working on a patch or a new feature, it is a good idea to discuss it first with BIND10 developers. You can post your -questions to bind10-dev +questions to the \c bind10-dev mailing list (https://lists.isc.org/mailman/listinfo/bind10-dev) for general BIND10 -stuff or to bind10-dhcp -(https://lists.isc.org/mailman/listinfo/bind10-dhcp) mailing lists for DHCP specific +stuff or to the \c bind10-dhcp mailing list +(https://lists.isc.org/mailman/listinfo/bind10-dhcp) for DHCP specific topics. If you prefer to get faster feedback, most BIND10 developers hang out at bind10 jabber room (xmpp:bind10@conference.jabber.isc.org). Those involved in DHCP also From d2b3d82dc02b9e6fe5fab81b78f6dfc532888d3b Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:14:04 +0530 Subject: [PATCH 05/27] [3109] Add articles --- doc/devel/contribute.dox | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 55200ebd9b..077e27d24a 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -29,9 +29,9 @@ questions to the \c bind10-dev mailing list stuff or to the \c bind10-dhcp mailing list (https://lists.isc.org/mailman/listinfo/bind10-dhcp) for DHCP specific topics. If you prefer to get faster feedback, most BIND10 developers -hang out at bind10 jabber room +hang out in the \c bind10 jabber room (xmpp:bind10@conference.jabber.isc.org). Those involved in DHCP also -use dhcp chatroom (xmpp:dhcp@conference.jabber.isc.org). Feel free to +use the \c dhcp chatroom (xmpp:dhcp@conference.jabber.isc.org). Feel free to drop a note. It is possible that someone else is working on your 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 From 2f326350f8f49fd6db247d38d6c3575e9e82a0a5 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:15:03 +0530 Subject: [PATCH 06/27] [3109] Update text --- doc/devel/contribute.dox | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 077e27d24a..256b525fde 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -32,9 +32,9 @@ topics. If you prefer to get faster feedback, most BIND10 developers hang out in the \c bind10 jabber room (xmpp:bind10@conference.jabber.isc.org). Those involved in DHCP also use the \c dhcp chatroom (xmpp:dhcp@conference.jabber.isc.org). Feel free to -drop a note. It is possible that someone else is working on your +join these rooms and talk to us. It is possible that someone else is working on your 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 +the best one. Often having a 10 minute talk could save many hours of engineering work. First step would be to get a source code from our GIT repository. The procedure From e18f0aeceb9095198c3081cbd08e772a5715baf8 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:15:56 +0530 Subject: [PATCH 07/27] [3109] Re-justify paragraph (after changes in previous commits) --- doc/devel/contribute.dox | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 256b525fde..29f5c94246 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -23,19 +23,19 @@ changes and not get disappointed in the process. @section contributorGuideWritePatch Writing a patch Before you start working on a patch or a new feature, it is a good idea -to discuss it first with BIND10 developers. You can post your -questions to the \c bind10-dev mailing list +to discuss it first with BIND10 developers. You can post your questions +to the \c bind10-dev mailing list (https://lists.isc.org/mailman/listinfo/bind10-dev) for general BIND10 stuff or to the \c bind10-dhcp mailing list (https://lists.isc.org/mailman/listinfo/bind10-dhcp) for DHCP specific topics. If you prefer to get faster feedback, most BIND10 developers hang out in the \c bind10 jabber room -(xmpp:bind10@conference.jabber.isc.org). Those involved in DHCP also -use the \c dhcp chatroom (xmpp:dhcp@conference.jabber.isc.org). Feel free to -join these rooms and talk to us. It is possible that someone else is working on your -specific issue or perhaps the solution you plan to implement is not -the best one. Often having a 10 minute talk could save many hours of -engineering work. +(xmpp:bind10@conference.jabber.isc.org). Those involved in DHCP also use +the \c dhcp chatroom (xmpp:dhcp@conference.jabber.isc.org). Feel free to +join these rooms and talk to us. It is possible that someone else is +working on your specific issue or perhaps the solution you plan to +implement is not the best one. Often having a 10 minute 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. From e674965bfb4fefd24fd44b70e80429ddea92e6ca Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:16:54 +0530 Subject: [PATCH 08/27] [3109] Add punctuation --- doc/devel/contribute.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 29f5c94246..0ddd6d1f9b 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -26,7 +26,7 @@ Before you start working on a patch or a new feature, it is a good idea to discuss it first with BIND10 developers. You can post your questions to the \c bind10-dev mailing list (https://lists.isc.org/mailman/listinfo/bind10-dev) for general BIND10 -stuff or to the \c bind10-dhcp mailing list +stuff, or to the \c bind10-dhcp mailing list (https://lists.isc.org/mailman/listinfo/bind10-dhcp) for DHCP specific topics. If you prefer to get faster feedback, most BIND10 developers hang out in the \c bind10 jabber room From 08d4a94ef93b4a1fb0ba0fcbadc3793793c8c73a Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:17:51 +0530 Subject: [PATCH 09/27] [3109] Update text --- doc/devel/contribute.dox | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 0ddd6d1f9b..3dffeaa02a 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -37,10 +37,10 @@ working on your specific issue or perhaps the solution you plan to implement is not the best one. Often having a 10 minute talk could save many hours of engineering work. -First step would be to get a source code from our GIT repository. The procedure +First step would be to get the 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. +While it is possible to provide a patch against the latest stable release, it makes +the review process much easier if it is for latest code from the Git \c 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 From 14aecfe2eb61e067200a91684eec7b04b10e0634 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:18:03 +0530 Subject: [PATCH 10/27] [3109] Re-justify paragraph (after changes in previous commits) --- doc/devel/contribute.dox | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 3dffeaa02a..6d8d95bb08 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -37,10 +37,12 @@ working on your specific issue or perhaps the solution you plan to implement is not the best one. Often having a 10 minute talk could save many hours of engineering work. -First step would be to get the 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 the latest stable release, it makes -the review process much easier if it is for latest code from the Git \c master branch. +First step would be to get the 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 the latest stable release, it makes the review +process much easier if it is for latest code from the Git \c 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 From 0e24ff0516f95c8f0ae4a4b82892d97e40891530 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:22:12 +0530 Subject: [PATCH 11/27] [3109] Update text --- doc/devel/contribute.dox | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 6d8d95bb08..2251885ca5 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -44,13 +44,13 @@ provide a patch against the latest stable release, it makes the review process much easier if it is for latest code from the Git \c 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 -BIND10 is a portable software. Besides Linux, it is being compiled on -relatively uncommon systems, like OpenBSD or Solaris 11. Will your -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 +Ok, so you have written a patch? Great! Before you submit it, make sure that +your code compiles. This may seem obvious, but there's more to +it. You have surely checked that it compiles on your system, but +BIND10 is portable software. Besides Linux, it is compiled and used on +relatively uncommon systems like OpenBSD and Solaris 11. Will your +code compile and work there? What about endianess? It is likely +that you used a regular x86 architecture machine to write your patch, but the software is expected to run on many other architectures. Does your patch conforms to BIND10 From d640e2711d36ff59c9adf84b092ccba7f17ef46a Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:22:33 +0530 Subject: [PATCH 12/27] [3109] Re-justify paragraph (after changes in previous commits) --- doc/devel/contribute.dox | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 2251885ca5..0d57974882 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -44,14 +44,14 @@ provide a patch against the latest stable release, it makes the review process much easier if it is for latest code from the Git \c master branch. -Ok, so you have written a patch? Great! Before you submit it, make sure that -your code compiles. This may seem obvious, but there's more to -it. You have surely checked that it compiles on your system, but -BIND10 is portable software. Besides Linux, it is compiled and used on -relatively uncommon systems like OpenBSD and Solaris 11. Will your -code compile and work there? What about endianess? It is likely -that you used a regular x86 architecture machine to write your patch, but the software is expected to run on many -other architectures. +Ok, so you have written a patch? Great! Before you submit it, make sure +that your code compiles. This may seem obvious, but there's more to +it. You have surely checked that it compiles on your system, but BIND10 +is portable software. Besides Linux, it is compiled and used on +relatively uncommon systems like OpenBSD and Solaris 11. Will your code +compile and work there? What about endianess? It is likely that you used +a regular x86 architecture machine to write your patch, but the software +is expected to run on many other architectures. Does your patch conforms to BIND10 http://bind10.isc.org/wiki/CodingGuidelines? You still can submit From 7d35d92626c35bd28ba4cf195fb679f44091bf6b Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:28:50 +0530 Subject: [PATCH 13/27] [3109] Update text --- doc/devel/contribute.dox | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 0d57974882..8a72cd7501 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -53,13 +53,13 @@ compile and work there? What about endianess? It is likely that you used a regular x86 architecture machine to write your patch, but the software is expected to run on many other architectures. -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 -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. +Does your patch conform to BIND10 +? You still can submit +a patch that does not adhere to it, but that will decrease its +chances of being accepted. If the deviations are minor, the BIND10 engineer +who does the review will likely fix the issues. However, +if there are lots of issues, the reviewer may simply reject the patch +and ask you to fix it before re-submitting. @section contributorGuideUnittests Running unit-tests From 8bf74aab112eeac3471cc9d9ebdfb74cac970176 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:29:09 +0530 Subject: [PATCH 14/27] [3109] Re-justify paragraph (after changes in previous commits) --- doc/devel/contribute.dox | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 8a72cd7501..7e808ff137 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -54,12 +54,12 @@ a regular x86 architecture machine to write your patch, but the software is expected to run on many other architectures. Does your patch conform to BIND10 -? You still can submit -a patch that does not adhere to it, but that will decrease its -chances of being accepted. If the deviations are minor, the BIND10 engineer -who does the review will likely fix the issues. However, -if there are lots of issues, the reviewer may simply reject the patch -and ask you to fix it before re-submitting. +? You still can submit a +patch that does not adhere to it, but that will decrease its chances of +being accepted. If the deviations are minor, the BIND10 engineer who +does the review will likely fix the issues. However, if there are lots +of issues, the reviewer may simply reject the patch and ask you to fix +it before re-submitting. @section contributorGuideUnittests Running unit-tests From 3f5af01217a8e67822a9a25744b06579390a57f5 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:47:18 +0530 Subject: [PATCH 15/27] [3109] Update text --- doc/devel/contribute.dox | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 7e808ff137..93f83b407e 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -66,15 +66,17 @@ it before re-submitting. 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 +like a single line fix, it is encouraged to write unit-tests 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. -BIND10 uses google test (gtest) framework as a base for our +BIND10 uses the Google C++ Testing Framework (also called googletest or gtest) as a base for our C++ 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 +For Python unit-tests, we use the its \c unittest library which is +included in Python. +You must have \c gtest installed or at least extracted in a directory before compiling +BIND10 unit-tests. To enable unit-tests in BIND10, use @code ./configure --with-gtest=/path/to/your/gtest/dir From 19cb9064139e3b2adcf26bef7d7fdd38db356010 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:48:13 +0530 Subject: [PATCH 16/27] [3109] Re-justify paragraph (after changes in previous commits) --- doc/devel/contribute.dox | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 93f83b407e..2216092217 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -71,12 +71,12 @@ 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. -BIND10 uses the Google C++ Testing Framework (also called googletest or gtest) as a base for our C++ -unit-tests. See http://code.google.com/p/googletest/ for details. -For Python unit-tests, we use the its \c unittest library which is -included in Python. -You must have \c gtest installed or at least extracted in a directory before compiling -BIND10 unit-tests. To enable unit-tests in BIND10, use +BIND10 uses the Google C++ Testing Framework (also called googletest or +gtest) as a base for our C++ unit-tests. See +http://code.google.com/p/googletest/ for details. For Python unit-tests, +we use the its \c unittest library which is included in Python. You must +have \c gtest installed or at least extracted in a directory before +compiling BIND10 unit-tests. To enable unit-tests in BIND10, use @code ./configure --with-gtest=/path/to/your/gtest/dir From 37bb1f516ee852871f61b92d7bb5f50ba79a4b0f Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:50:41 +0530 Subject: [PATCH 17/27] [3109] Update text --- doc/devel/contribute.dox | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 2216092217..949c4ba758 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -76,7 +76,7 @@ gtest) as a base for our C++ unit-tests. See http://code.google.com/p/googletest/ for details. For Python unit-tests, we use the its \c unittest library which is included in Python. You must have \c gtest installed or at least extracted in a directory before -compiling BIND10 unit-tests. To enable unit-tests in BIND10, use +compiling BIND10 unit-tests. To enable unit-tests in BIND10, use: @code ./configure --with-gtest=/path/to/your/gtest/dir @@ -88,13 +88,13 @@ or ./configure --with-gtest-source=/path/to/your/gtest/dir @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 +There are other useful switches which can be passed to configure. It is always a good +idea to use \c --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 +\c --enable-generate-docs. If you are modifying DHCP code, you are likely +to be interested in enabling the MySQL backend for DHCP. Note that if the backend +is not enabled, MySQL specific unit-tests are skipped. From that +perspective, it is useful to use \c --with-dhcp-mysql. For a complete list of all switches, use: @code From 2f3324cbeeada97f94105d9c8ce902f496e34dd3 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:51:49 +0530 Subject: [PATCH 18/27] [3109] Re-justify paragraph (after changes in previous commits) --- doc/devel/contribute.dox | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 949c4ba758..f408c1e547 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -88,14 +88,14 @@ or ./configure --with-gtest-source=/path/to/your/gtest/dir @endcode -There are other useful switches which can be passed to configure. It is always a good -idea to use \c --enable-logger-checks, which does sanity checks on logger -parameters. If you happen to modify anything in the documentation, use -\c --enable-generate-docs. If you are modifying DHCP code, you are likely -to be interested in enabling the MySQL backend for DHCP. Note that if the backend -is not enabled, MySQL specific unit-tests are skipped. From that -perspective, it is useful to use \c --with-dhcp-mysql. For a -complete list of all switches, use: +There are other useful switches which can be passed to configure. It is +always a good idea to use \c --enable-logger-checks, which does sanity +checks on logger parameters. If you happen to modify anything in the +documentation, use \c --enable-generate-docs. If you are modifying DHCP +code, you are likely to be interested in enabling the MySQL backend for +DHCP. Note that if the backend is not enabled, MySQL specific unit-tests +are skipped. From that perspective, it is useful to use +\c --with-dhcp-mysql. For a complete list of all switches, use: @code ./configure --help From 677e0bd0a52306ea81f3a7bab51257ffc466b856 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:52:13 +0530 Subject: [PATCH 19/27] [3109] Move paragraphs to maintain context --- doc/devel/contribute.dox | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index f408c1e547..fdaf6dfeac 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -88,19 +88,6 @@ or ./configure --with-gtest-source=/path/to/your/gtest/dir @endcode -There are other useful switches which can be passed to configure. It is -always a good idea to use \c --enable-logger-checks, which does sanity -checks on logger parameters. If you happen to modify anything in the -documentation, use \c --enable-generate-docs. If you are modifying DHCP -code, you are likely to be interested in enabling the MySQL backend for -DHCP. Note that if the backend is not enabled, MySQL specific unit-tests -are skipped. From that perspective, it is useful to use -\c --with-dhcp-mysql. For a complete list of all switches, use: - -@code - ./configure --help -@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: @@ -116,6 +103,19 @@ good idea to check if you haven't broken distribution process: make distcheck @endcode +There are other useful switches which can be passed to configure. It is +always a good idea to use \c --enable-logger-checks, which does sanity +checks on logger parameters. If you happen to modify anything in the +documentation, use \c --enable-generate-docs. If you are modifying DHCP +code, you are likely to be interested in enabling the MySQL backend for +DHCP. Note that if the backend is not enabled, MySQL specific unit-tests +are skipped. From that perspective, it is useful to use +\c --with-dhcp-mysql. For a complete list of all switches, use: + +@code + ./configure --help +@endcode + @section contributorGuideReview Going through a review Once all those are checked and working, feel free to create a ticket From 1e278e019742e8f13b93d6f670d50eb14e675217 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:53:48 +0530 Subject: [PATCH 20/27] [3109] Update text --- doc/devel/contribute.dox | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index fdaf6dfeac..f858aafb42 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -88,16 +88,16 @@ or ./configure --with-gtest-source=/path/to/your/gtest/dir @endcode -Depending on how you compiled or installed (e.g. from sources or using +Depending on how you compiled or installed \c gtest (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: +\c gtest. After that you make run unit-tests: @code make check @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: +If you happen to add new files or have modified any \c Makefile.am files, it is also a +good idea to check if you haven't broken the distribution process: @code make distcheck From 3b9c90d00e5b0c2790a9d7c94b8765b61a6b64a0 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:54:00 +0530 Subject: [PATCH 21/27] [3109] Re-justify paragraphs (after changes in previous commits) --- doc/devel/contribute.dox | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index f858aafb42..2dce245e10 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -88,16 +88,17 @@ or ./configure --with-gtest-source=/path/to/your/gtest/dir @endcode -Depending on how you compiled or installed \c gtest (e.g. from sources or using -some package management system) one of those two switches will find -\c gtest. After that you make run unit-tests: +Depending on how you compiled or installed \c gtest (e.g. from sources +or using some package management system) one of those two switches will +find \c gtest. After that you make run unit-tests: @code make check @endcode -If you happen to add new files or have modified any \c Makefile.am files, it is also a -good idea to check if you haven't broken the distribution process: +If you happen to add new files or have modified any \c Makefile.am +files, it is also a good idea to check if you haven't broken the +distribution process: @code make distcheck From f83c6c44a65b4cb04d3e2691e5bf0a3bf82d59c0 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 12:59:52 +0530 Subject: [PATCH 22/27] [3109] Update text --- doc/devel/contribute.dox | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 2dce245e10..c32ba9519d 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -120,27 +120,28 @@ are skipped. From that perspective, it is useful to use @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 -existing ticket if there is one. You may drop a note to bind10 or dhcp +for your patch at http://bind10.isc.org/ or attach your patch to an +existing ticket if you have fixed it. It would be nice if you also join the \c bind10 or \c dhcp chatroom saying that you have submitted a patch. Alternatively, you -may send a note to bind10-dev or bind10-dhcp lists. +may send a note to the \c bind10-dev or \c bind10-dhcp mailing lists. Here's the tricky part. One of BIND10 developers will review your patch, but it may not happen immediately. Unfortunately, developers -are usually working under tight schedule, so any extra unplanned -review work sometimes make take a while. Having said that, we value +are usually working under a tight schedule, so any extra unplanned +review work may take a while sometimes. Having said that, we value external contributions very much and will do whatever we can to review patches in a timely manner. Don't get discouraged if your patch is not accepted after first review. To keep the code quality high, we use the same review processes for internal code and for -external patches. It may take several cycles of review/updated patch +external patches. It may take some cycles of review/updated patch submissions before the code is finally accepted. -Once the process is almost completed, the developer will likely ask +Once the process is almost complete, the developer will likely ask you how you would like to be credited. The typical answers are by -first,last name, by nickname, by company or anonymously. Typically we -will add a note to ChangeLog. If the contributted feature is big or -critical for whatever reason, it may be also mentioned in release +first and last name, by nickname, by company name or anonymously. Typically we +will add a note to the \c ChangeLog and also set you as the author of the +commit applying the patch. If the contributted feature is big or +critical for whatever reason, it may also be mentioned in release notes. @section contributorGuideExtra Extra steps From e2dbd7090ae49267e0ff14f593de49629afbf710 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 13:00:20 +0530 Subject: [PATCH 23/27] [3109] Re-justify paragraphs (after changes in previous commits) --- doc/devel/contribute.dox | 44 ++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index c32ba9519d..b781828d74 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -119,30 +119,30 @@ are skipped. From that perspective, it is useful to use @section contributorGuideReview Going through a review -Once all those are checked and working, feel free to create a ticket -for your patch at http://bind10.isc.org/ or attach your patch to an -existing ticket if you have fixed it. It would be nice if you also join the \c bind10 or \c dhcp -chatroom saying that you have submitted a patch. Alternatively, you -may send a note to the \c bind10-dev or \c bind10-dhcp mailing lists. +Once all those are checked and working, feel free to create a ticket for +your patch at http://bind10.isc.org/ or attach your patch to an existing +ticket if you have fixed it. It would be nice if you also join the +\c bind10 or \c dhcp chatroom saying that you have submitted a +patch. Alternatively, you may send a note to the \c bind10-dev or +\c bind10-dhcp mailing lists. -Here's the tricky part. One of BIND10 developers will review your -patch, but it may not happen immediately. Unfortunately, developers -are usually working under a tight schedule, so any extra unplanned -review work may take a while sometimes. Having said that, we value -external contributions very much and will do whatever we can to -review patches in a timely manner. Don't get discouraged if your -patch is not accepted after first review. To keep the code quality -high, we use the same review processes for internal code and for -external patches. It may take some cycles of review/updated patch -submissions before the code is finally accepted. +Here's the tricky part. One of BIND10 developers will review your patch, +but it may not happen immediately. Unfortunately, developers are usually +working under a tight schedule, so any extra unplanned review work may +take a while sometimes. Having said that, we value external +contributions very much and will do whatever we can to review patches in +a timely manner. Don't get discouraged if your patch is not accepted +after first review. To keep the code quality high, we use the same +review processes for internal code and for external patches. It may take +some cycles of review/updated patch submissions before the code is +finally accepted. -Once the process is almost complete, the developer will likely ask -you how you would like to be credited. The typical answers are by -first and last name, by nickname, by company name or anonymously. Typically we -will add a note to the \c ChangeLog and also set you as the author of the -commit applying the patch. If the contributted feature is big or -critical for whatever reason, it may also be mentioned in release -notes. +Once the process is almost complete, the developer will likely ask you +how you would like to be credited. The typical answers are by first and +last name, by nickname, by company name or anonymously. Typically we +will add a note to the \c ChangeLog and also set you as the author of +the commit applying the patch. If the contributted feature is big or +critical for whatever reason, it may also be mentioned in release notes. @section contributorGuideExtra Extra steps From 273b3105e21cfa457381983bf0c98f2590c55ebd Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 13:03:22 +0530 Subject: [PATCH 24/27] [3109] Update text --- doc/devel/contribute.dox | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index b781828d74..9ddf14fecd 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -146,11 +146,11 @@ critical for whatever reason, it may also be mentioned in release notes. @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 +If you are interested in knowing the results of more in-depth testing, you are welcome +to visit the BIND10 build farm: http://git.bind10.isc.org/~tester/builder/builder-new.html. +This is a live result page with all tests being run on various systems. +Besides basic unit-tests, we also have reports from Valgrind (memory debugger), +cppcheck and clang-analyzer (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. From 342c56224c215ca1cb245df0875878e4f8fad0e6 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Thu, 12 Sep 2013 13:03:50 +0530 Subject: [PATCH 25/27] [3109] Re-justify paragraphs (after changes in previous commits) --- doc/devel/contribute.dox | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index 9ddf14fecd..af5142a1ad 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -146,13 +146,14 @@ critical for whatever reason, it may also be mentioned in release notes. @section contributorGuideExtra Extra steps -If you are interested in knowing the results of more in-depth testing, you are welcome -to visit the BIND10 build farm: http://git.bind10.isc.org/~tester/builder/builder-new.html. -This is a live result page with all tests being run on various systems. -Besides basic unit-tests, we also have reports from Valgrind (memory debugger), -cppcheck and clang-analyzer (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. +If you are interested in knowing the results of more in-depth testing, +you are welcome to visit the BIND10 build farm: +http://git.bind10.isc.org/~tester/builder/builder-new.html. This is a +live result page with all tests being run on various systems. Besides +basic unit-tests, we also have reports from Valgrind (memory debugger), +cppcheck and clang-analyzer (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. */ From ae4ce59aabd5281822630668956425fa6167eca8 Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Thu, 5 Dec 2013 19:10:20 +0100 Subject: [PATCH 26/27] [3109] Added proposed chages in review: - eased language - added link to system specific notes - fixed coding guidelines link to look better - added link to our build farm --- doc/devel/contribute.dox | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/devel/contribute.dox b/doc/devel/contribute.dox index af5142a1ad..9103bedd7d 100644 --- a/doc/devel/contribute.dox +++ b/doc/devel/contribute.dox @@ -18,7 +18,7 @@ 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. +changes smoothly. @section contributorGuideWritePatch Writing a patch @@ -51,10 +51,13 @@ is portable software. Besides Linux, it is compiled and used on relatively uncommon systems like OpenBSD and Solaris 11. Will your code compile and work there? What about endianess? It is likely that you used a regular x86 architecture machine to write your patch, but the software -is expected to run on many other architectures. +is expected to run on many other architectures. You may take a look at +system specific build notes (http://bind10.isc.org/wiki/SystemSpecificNotes). +For a complete list of systems we build on, you may take a look at the +following build farm report: http://git.bind10.isc.org/~tester/builder/builder-new.html . -Does your patch conform to BIND10 -? You still can submit a +Does your patch conform to BIND10 coding guidelines +(http://bind10.isc.org/wiki/CodingGuidelines)? You still can submit a patch that does not adhere to it, but that will decrease its chances of being accepted. If the deviations are minor, the BIND10 engineer who does the review will likely fix the issues. However, if there are lots From 016bfae00460b4f88adbfd07ed26759eb294ef10 Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Thu, 5 Dec 2013 19:10:43 +0100 Subject: [PATCH 27/27] [3109] ChangeLog updated --- ChangeLog | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/ChangeLog b/ChangeLog index ed17181823..268e0aa721 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +6XX. [doc] tomek + BIND10 Contributor's Guide added. + (Trac #3109, git ABCD) + 663. [func] marcin b10-dhcp6: Server processes the DHCPv6 Client FQDN Option sent by a client and generates the response. The DHCPv6 Client