From 5893debf46ce1b5fbe793114a59da28fac4cccb7 Mon Sep 17 00:00:00 2001 From: Tom Krizek Date: Wed, 7 Jun 2023 16:00:00 +0200 Subject: [PATCH] Remove trailing whitespace from all text files I've used the following command to remove the trailing whitespace for all tracked text files: git grep -Il '' | xargs sed -i 's/[ \t]*$//' --- .dir-locals.el | 6 +- COPYRIGHT | 50 +- bin/delv/delv.rst | 2 +- bin/dnssec/dnssec-settime.rst | 2 +- bin/tests/startperf/makenames.pl | 2 +- bin/tests/startperf/mkzonefile.pl | 2 +- bin/tests/system/ans.pl | 10 +- bin/tests/system/checkconf/dnssec.2 | 2 +- bin/tests/system/checkconf/dnssec.3 | 2 +- bin/tests/system/digdelv/clean.sh | 2 +- .../CA/certs/srv01.client01.example.com.pem | 2 +- .../certs/srv01.client02-ns2.example.com.pem | 2 +- ...srv01.client03-ns2-expired.example.com.pem | 2 +- .../doth/CA/certs/srv01.crt01.example.com.pem | 2 +- .../certs/srv01.crt03-expired.example.com.pem | 2 +- .../doth/CA/certs/srv02.crt01.example.com.pem | 2 +- .../doth/CA/certs/srv03.crt01.example.com.pem | 2 +- .../doth/CA/certs/srv04.crt01.example.com.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52001.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52003.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52004.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52005.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52006.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52007.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52008.pem | 2 +- .../doth/CA/newcerts/6BB3183CDEF52009.pem | 2 +- bin/tests/system/doth/example.axfr.good | 2 +- bin/tests/system/doth/example8.axfr.good | 2 +- bin/tests/system/fetchlimit/tests.sh | 2 +- bin/tests/system/formerr/clean.sh | 6 +- bin/tests/system/formerr/formerr.pl | 2 +- .../CA/certs/srv02.crt01.example.nil.pem | 6 +- .../certs/srv02.crt02-expired.example.nil.pem | 6 +- .../CA/certs/srv04.crt01.example.nil.pem | 6 +- .../forward/CA/newcerts/CCC118082632E18B.pem | 6 +- .../forward/CA/newcerts/CCC118082632E18C.pem | 6 +- .../forward/CA/newcerts/CCC118082632E18D.pem | 6 +- bin/tests/system/genzone.sh | 14 +- bin/tests/system/inline/ns3/sign.sh | 4 +- bin/tests/system/legacy/ns6/sign.sh | 2 +- bin/tests/system/legacy/ns7/sign.sh | 2 +- bin/tests/system/metadata/clean.sh | 2 +- .../CA/certs/srv01.client01.example.nil.pem | 2 +- .../srv01.client02-expired.example.nil.pem | 2 +- .../CA/certs/srv01.crt01.example.nil.pem | 2 +- .../certs/srv01.crt02-expired.example.nil.pem | 2 +- .../nsupdate/CA/newcerts/70B9F4EB2FA19598.pem | 2 +- .../nsupdate/CA/newcerts/70B9F4EB2FA19599.pem | 2 +- .../nsupdate/CA/newcerts/70B9F4EB2FA1959A.pem | 2 +- .../nsupdate/CA/newcerts/70B9F4EB2FA1959B.pem | 2 +- bin/tests/system/pending/ns1/sign.sh | 2 +- bin/tests/system/resolver/tests.sh | 2 +- bin/tests/system/rndc/ns6/named.args | 2 +- bin/tests/system/rrl/tests.sh | 14 +- .../system/rsabigexponent/ns1/root.db.in | 2 +- bin/tests/system/runtime/setup.sh | 2 +- bin/tests/system/staticstub/ns3/sign.sh | 2 +- bin/tests/system/stop.pl | 2 +- bin/tests/system/stress/setup.pl | 4 +- bin/tests/system/tsig/tests.sh | 4 +- .../system/tsiggss/ns1/example.nil.db.in | 2 +- bin/tests/system/upforwd/ans4/ans.pl | 10 +- bin/tests/system/zonechecks/tests.sh | 4 +- contrib/README | 2 +- .../modules/bdbhpt/testing/bdbhpt-populate.pl | 6 +- contrib/dlz/modules/ldap/testing/slapd.conf | 4 +- contrib/dlz/modules/mysqldyn/README | 2 +- contrib/scripts/zone-edit.sh.in | 8 +- doc/arm/dns-ops.inc.rst | 2 +- doc/arm/intro-dns-bind.inc.rst | 104 +- doc/arm/intro-security.inc.rst | 62 +- doc/arm/introduction.inc.rst | 12 +- doc/arm/logging-categories.inc.rst | 12 +- doc/arm/reference.rst | 2 +- doc/arm/security.inc.rst | 2 +- doc/arm/troubleshooting.inc.rst | 2 +- doc/design/cds-child | 2 +- doc/design/dnssec-policy | 2 +- doc/design/netmgr.md | 4 +- doc/dev/dev.md | 12 +- doc/dnssec-guide/introduction.rst | 4 +- doc/dnssec-guide/preface.rst | 2 +- doc/dnssec-guide/recipes.rst | 6 +- doc/dnssec-guide/signing.rst | 4 +- doc/dnssec-guide/troubleshooting.rst | 6 +- doc/doxygen/Doxyfile.in | 1010 ++++++++--------- util/check-pullups.pl | 2 +- 87 files changed, 764 insertions(+), 764 deletions(-) diff --git a/.dir-locals.el b/.dir-locals.el index bad3fddb04..7e70739b68 100644 --- a/.dir-locals.el +++ b/.dir-locals.el @@ -52,7 +52,7 @@ ;; libtest (expand-file-name (concat directory-of-current-dir-locals-file "tests/include")) - + ;; bin (expand-file-name (concat directory-of-current-dir-locals-file "bin/check")) @@ -61,7 +61,7 @@ (expand-file-name (concat directory-of-current-dir-locals-file "bin/confgen")) (expand-file-name - (concat directory-of-current-dir-locals-file "bin/confgen/include")) + (concat directory-of-current-dir-locals-file "bin/confgen/include")) (expand-file-name (concat directory-of-current-dir-locals-file "bin/dig/include")) (expand-file-name @@ -79,7 +79,7 @@ (expand-file-name "/usr/include/libxml2") (expand-file-name "/usr/include/json-c") - + (expand-file-name "/usr/local/opt/openssl@1.1/include") (expand-file-name "/usr/local/opt/libxml2/include/libxml2") (expand-file-name "/usr/local/opt/json-c/include/json-c/") diff --git a/COPYRIGHT b/COPYRIGHT index f9413d0747..12f791767c 100644 --- a/COPYRIGHT +++ b/COPYRIGHT @@ -133,7 +133,7 @@ modification, are permitted provided that the following conditions are met: 3. Neither the name of the University nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE @@ -149,35 +149,35 @@ POSSIBILITY OF SUCH DAMAGE. ----------------------------------------------------------------------------- Copyright (c) 1997 - 2003 Kungliga Tekniska Högskolan -(Royal Institute of Technology, Stockholm, Sweden). -All rights reserved. +(Royal Institute of Technology, Stockholm, Sweden). +All rights reserved. -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions -are met: +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: -1. Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. -3. Neither the name of the Institute nor the names of its contributors - may be used to endorse or promote products derived from this software - without specific prior written permission. +3. Neither the name of the Institute nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. -THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -SUCH DAMAGE. +THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. ----------------------------------------------------------------------------- diff --git a/bin/delv/delv.rst b/bin/delv/delv.rst index 61d1b701a9..2ab1f897f4 100644 --- a/bin/delv/delv.rst +++ b/bin/delv/delv.rst @@ -293,7 +293,7 @@ assign values to options like the timeout interval. They have the form This option toggles logging of messages sent. This produces a detailed dump of the queries sent by :program:`delv` in the process of carrying - out the resolution and validation process. Turning on this option + out the resolution and validation process. Turning on this option also activates ``+mtrace``. This is equivalent to setting the debug level to 11 for the "packets" diff --git a/bin/dnssec/dnssec-settime.rst b/bin/dnssec/dnssec-settime.rst index 790775646e..5cb4ea8370 100644 --- a/bin/dnssec/dnssec-settime.rst +++ b/bin/dnssec/dnssec-settime.rst @@ -148,7 +148,7 @@ All these formats are case-insensitive. .. option:: -A date/offset This option sets the date on which the key is to be activated. After that date, - the key is included in the zone and used to sign it. + the key is included in the zone and used to sign it. .. option:: -R date/offset diff --git a/bin/tests/startperf/makenames.pl b/bin/tests/startperf/makenames.pl index cb4a73464d..ba2c5a82c8 100644 --- a/bin/tests/startperf/makenames.pl +++ b/bin/tests/startperf/makenames.pl @@ -19,7 +19,7 @@ $len = @ARGV[1] if (@ARGV == 2); my @chars = split("", "abcdefghijklmnopqrstuvwxyz123456789"); -srand; +srand; for (my $i = 0; $i < @ARGV[0]; $i++) { my $name = ""; for (my $j = 0; $j < $len; $j++) { diff --git a/bin/tests/startperf/mkzonefile.pl b/bin/tests/startperf/mkzonefile.pl index 3fdc802fd2..f8965a0433 100644 --- a/bin/tests/startperf/mkzonefile.pl +++ b/bin/tests/startperf/mkzonefile.pl @@ -31,7 +31,7 @@ print"\$TTL 300 ; 5 minutes NS ns ns A 10.53.0.3\n"; -srand; +srand; for (my $i = 0; $i < $nrecords; $i++) { my $name = ""; for (my $j = 0; $j < 8; $j++) { diff --git a/bin/tests/system/ans.pl b/bin/tests/system/ans.pl index b74333b255..bbae89ef57 100644 --- a/bin/tests/system/ans.pl +++ b/bin/tests/system/ans.pl @@ -205,7 +205,7 @@ sub handleUDP { $prev_tsig->mac); } } - + $packet->sign_tsig($tsig); } last; @@ -253,7 +253,7 @@ sub packetlen { } else { ($header, $offset) = Net::DNS::Header->parse(\$data); } - + for (1 .. $header->qdcount) { if ($decode) { ($q, $offset) = @@ -339,7 +339,7 @@ sub handleTCP { ($request, $err) = new Net::DNS::Packet(\$buf, 0); $err and die $err; } - + my @questions = $request->question; my $qname = $questions[0]->qname; my $qtype = $questions[0]->qtype; @@ -387,7 +387,7 @@ sub handleTCP { if (defined($key_name) && defined($key_data)) { my $tsig; # sign the packet - print " Signing the data with " . + print " Signing the data with " . "$key_name/$key_data\n"; if ($Net::DNS::VERSION < 0.69) { @@ -431,7 +431,7 @@ sub handleTCP { $prev_tsig->mac); } } - + $tsig->sign_func($signer) if defined($signer); $tsig->continuation($continuation) if ($Net::DNS::VERSION >= 0.71 && diff --git a/bin/tests/system/checkconf/dnssec.2 b/bin/tests/system/checkconf/dnssec.2 index d71402ae49..0f6a8afdd2 100644 --- a/bin/tests/system/checkconf/dnssec.2 +++ b/bin/tests/system/checkconf/dnssec.2 @@ -1,6 +1,6 @@ /* * Copyright (C) Internet Systems Consortium, Inc. ("ISC") - * + * * SPDX-License-Identifier: MPL-2.0 * * This Source Code Form is subject to the terms of the Mozilla Public diff --git a/bin/tests/system/checkconf/dnssec.3 b/bin/tests/system/checkconf/dnssec.3 index cd37d14278..53e5d9158e 100644 --- a/bin/tests/system/checkconf/dnssec.3 +++ b/bin/tests/system/checkconf/dnssec.3 @@ -1,6 +1,6 @@ /* * Copyright (C) Internet Systems Consortium, Inc. ("ISC") - * + * * SPDX-License-Identifier: MPL-2.0 * * This Source Code Form is subject to the terms of the Mozilla Public diff --git a/bin/tests/system/digdelv/clean.sh b/bin/tests/system/digdelv/clean.sh index a64603600c..70797f0b93 100644 --- a/bin/tests/system/digdelv/clean.sh +++ b/bin/tests/system/digdelv/clean.sh @@ -31,7 +31,7 @@ rm -f ./ns*/named.lock rm -f ./ns*/K* ./ns*/keyid ./ns*/keydata rm -f ./ns1/root.db rm -f ./ns*/dsset-* -rm -f ./ns2/example.db +rm -f ./ns2/example.db rm -f ./ns2/example.tld.db rm -f ./nslookup.out.test* rm -f ./nsupdate.out.test* diff --git a/bin/tests/system/doth/CA/certs/srv01.client01.example.com.pem b/bin/tests/system/doth/CA/certs/srv01.client01.example.com.pem index 4eb45dd211..0b4c115d1c 100644 --- a/bin/tests/system/doth/CA/certs/srv01.client01.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv01.client01.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client01.example.com Signature Algorithm: sha256WithRSAEncryption 82:bd:eb:8f:4e:a5:d2:46:c7:d8:70:3c:34:1d:58:43:1b:81: diff --git a/bin/tests/system/doth/CA/certs/srv01.client02-ns2.example.com.pem b/bin/tests/system/doth/CA/certs/srv01.client02-ns2.example.com.pem index 36728e0e57..1b43bbd293 100644 --- a/bin/tests/system/doth/CA/certs/srv01.client02-ns2.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv01.client02-ns2.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client02-ns2.example.com Signature Algorithm: sha256WithRSAEncryption 43:ec:0f:62:17:f6:f4:90:3b:7c:36:21:f2:18:94:a6:42:51: diff --git a/bin/tests/system/doth/CA/certs/srv01.client03-ns2-expired.example.com.pem b/bin/tests/system/doth/CA/certs/srv01.client03-ns2-expired.example.com.pem index 8248191ecc..99e4a71e33 100644 --- a/bin/tests/system/doth/CA/certs/srv01.client03-ns2-expired.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv01.client03-ns2-expired.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client03-ns2-expired.example.com Signature Algorithm: sha256WithRSAEncryption 38:12:1f:5f:26:b6:8e:9b:3f:77:89:5a:b8:e8:46:78:c3:d6: diff --git a/bin/tests/system/doth/CA/certs/srv01.crt01.example.com.pem b/bin/tests/system/doth/CA/certs/srv01.crt01.example.com.pem index 26f3870f10..8671dd3a77 100644 --- a/bin/tests/system/doth/CA/certs/srv01.crt01.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv01.crt01.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt01.example.com, IP Address:10.53.0.1, IP Address:FD92:7065:B8E:FFFF:0:0:0:1 Signature Algorithm: sha256WithRSAEncryption 79:0f:08:ab:18:cc:f9:7a:bd:47:21:99:a1:a3:76:04:7f:d7: diff --git a/bin/tests/system/doth/CA/certs/srv01.crt03-expired.example.com.pem b/bin/tests/system/doth/CA/certs/srv01.crt03-expired.example.com.pem index db981c99b2..4befde4237 100644 --- a/bin/tests/system/doth/CA/certs/srv01.crt03-expired.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv01.crt03-expired.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt03-expired.example.com, IP Address:10.53.0.1, IP Address:FD92:7065:B8E:FFFF:0:0:0:1 Signature Algorithm: sha256WithRSAEncryption 25:35:08:f6:e7:f0:83:81:be:65:31:1b:78:a8:04:84:fe:6a: diff --git a/bin/tests/system/doth/CA/certs/srv02.crt01.example.com.pem b/bin/tests/system/doth/CA/certs/srv02.crt01.example.com.pem index ddac0dbc8c..d061c2c754 100644 --- a/bin/tests/system/doth/CA/certs/srv02.crt01.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv02.crt01.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv02.crt01.example.com, IP Address:10.53.0.2, IP Address:FD92:7065:B8E:FFFF:0:0:0:2 Signature Algorithm: sha256WithRSAEncryption 89:ba:ae:4f:f8:3e:da:48:1f:5c:8f:ff:ee:d8:42:b0:0b:9b: diff --git a/bin/tests/system/doth/CA/certs/srv03.crt01.example.com.pem b/bin/tests/system/doth/CA/certs/srv03.crt01.example.com.pem index 1698989c28..39b48eeb40 100644 --- a/bin/tests/system/doth/CA/certs/srv03.crt01.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv03.crt01.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv03.crt01.example.com, IP Address:10.53.0.3, IP Address:FD92:7065:B8E:FFFF:0:0:0:3 Signature Algorithm: sha256WithRSAEncryption 8f:96:88:82:94:76:8e:97:b6:75:8b:e9:2b:4f:f3:8f:14:5c: diff --git a/bin/tests/system/doth/CA/certs/srv04.crt01.example.com.pem b/bin/tests/system/doth/CA/certs/srv04.crt01.example.com.pem index 2731f32881..b4e2d22a88 100644 --- a/bin/tests/system/doth/CA/certs/srv04.crt01.example.com.pem +++ b/bin/tests/system/doth/CA/certs/srv04.crt01.example.com.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv04.crt01.example.com, IP Address:10.53.0.4, IP Address:FD92:7065:B8E:FFFF:0:0:0:4 Signature Algorithm: sha256WithRSAEncryption 48:b5:38:59:79:e6:51:a6:ea:80:d7:d1:3c:29:03:70:31:e4: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52001.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52001.pem index 26f3870f10..8671dd3a77 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52001.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52001.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt01.example.com, IP Address:10.53.0.1, IP Address:FD92:7065:B8E:FFFF:0:0:0:1 Signature Algorithm: sha256WithRSAEncryption 79:0f:08:ab:18:cc:f9:7a:bd:47:21:99:a1:a3:76:04:7f:d7: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52003.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52003.pem index ddac0dbc8c..d061c2c754 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52003.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52003.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv02.crt01.example.com, IP Address:10.53.0.2, IP Address:FD92:7065:B8E:FFFF:0:0:0:2 Signature Algorithm: sha256WithRSAEncryption 89:ba:ae:4f:f8:3e:da:48:1f:5c:8f:ff:ee:d8:42:b0:0b:9b: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52004.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52004.pem index 1698989c28..39b48eeb40 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52004.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52004.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv03.crt01.example.com, IP Address:10.53.0.3, IP Address:FD92:7065:B8E:FFFF:0:0:0:3 Signature Algorithm: sha256WithRSAEncryption 8f:96:88:82:94:76:8e:97:b6:75:8b:e9:2b:4f:f3:8f:14:5c: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52005.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52005.pem index 2731f32881..b4e2d22a88 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52005.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52005.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv04.crt01.example.com, IP Address:10.53.0.4, IP Address:FD92:7065:B8E:FFFF:0:0:0:4 Signature Algorithm: sha256WithRSAEncryption 48:b5:38:59:79:e6:51:a6:ea:80:d7:d1:3c:29:03:70:31:e4: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52006.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52006.pem index db981c99b2..4befde4237 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52006.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52006.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt03-expired.example.com, IP Address:10.53.0.1, IP Address:FD92:7065:B8E:FFFF:0:0:0:1 Signature Algorithm: sha256WithRSAEncryption 25:35:08:f6:e7:f0:83:81:be:65:31:1b:78:a8:04:84:fe:6a: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52007.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52007.pem index 4eb45dd211..0b4c115d1c 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52007.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52007.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client01.example.com Signature Algorithm: sha256WithRSAEncryption 82:bd:eb:8f:4e:a5:d2:46:c7:d8:70:3c:34:1d:58:43:1b:81: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52008.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52008.pem index 36728e0e57..1b43bbd293 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52008.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52008.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client02-ns2.example.com Signature Algorithm: sha256WithRSAEncryption 43:ec:0f:62:17:f6:f4:90:3b:7c:36:21:f2:18:94:a6:42:51: diff --git a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52009.pem b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52009.pem index 8248191ecc..99e4a71e33 100644 --- a/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52009.pem +++ b/bin/tests/system/doth/CA/newcerts/6BB3183CDEF52009.pem @@ -22,7 +22,7 @@ Certificate: ASN1 OID: secp384r1 NIST CURVE: P-384 X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client03-ns2-expired.example.com Signature Algorithm: sha256WithRSAEncryption 38:12:1f:5f:26:b6:8e:9b:3f:77:89:5a:b8:e8:46:78:c3:d6: diff --git a/bin/tests/system/doth/example.axfr.good b/bin/tests/system/doth/example.axfr.good index 653fb46bda..539e58bfef 100644 --- a/bin/tests/system/doth/example.axfr.good +++ b/bin/tests/system/doth/example.axfr.good @@ -17,7 +17,7 @@ amtrelay04.example. 3600 IN AMTRELAY 0 0 2 :: amtrelay05.example. 3600 IN AMTRELAY 0 0 3 example.net. amtrelay06.example. 3600 IN AMTRELAY \# 2 0004 apl01.example. 3600 IN APL !1:10.0.0.1/32 1:10.0.0.0/24 -apl02.example. 3600 IN APL +apl02.example. 3600 IN APL atma01.example. 3600 IN ATMA +61200000000 atma02.example. 3600 IN ATMA +61200000000 atma03.example. 3600 IN ATMA 1234567890abcdef diff --git a/bin/tests/system/doth/example8.axfr.good b/bin/tests/system/doth/example8.axfr.good index b5d4cd6302..3eb511ce7a 100644 --- a/bin/tests/system/doth/example8.axfr.good +++ b/bin/tests/system/doth/example8.axfr.good @@ -17,7 +17,7 @@ amtrelay04.example8. 3600 IN AMTRELAY 0 0 2 :: amtrelay05.example8. 3600 IN AMTRELAY 0 0 3 example.net. amtrelay06.example8. 3600 IN AMTRELAY \# 2 0004 apl01.example8. 3600 IN APL !1:10.0.0.1/32 1:10.0.0.0/24 -apl02.example8. 3600 IN APL +apl02.example8. 3600 IN APL atma01.example8. 3600 IN ATMA +61200000000 atma02.example8. 3600 IN ATMA +61200000000 atma03.example8. 3600 IN ATMA 1234567890abcdef diff --git a/bin/tests/system/fetchlimit/tests.sh b/bin/tests/system/fetchlimit/tests.sh index 2938d57b1e..4bf0f6fb0c 100644 --- a/bin/tests/system/fetchlimit/tests.sh +++ b/bin/tests/system/fetchlimit/tests.sh @@ -38,7 +38,7 @@ burst() { } stat() { - clients=`rndccmd ${1} status | grep "recursive clients" | + clients=`rndccmd ${1} status | grep "recursive clients" | sed 's;.*: \([^/][^/]*\)/.*;\1;'` echo_i "clients: $clients" [ "$clients" = "" ] && return 1 diff --git a/bin/tests/system/formerr/clean.sh b/bin/tests/system/formerr/clean.sh index e52553075d..05d08a7925 100644 --- a/bin/tests/system/formerr/clean.sh +++ b/bin/tests/system/formerr/clean.sh @@ -11,9 +11,9 @@ # See the COPYRIGHT file distributed with this work for additional # information regarding copyright ownership. -rm -f nametoolong.out -rm -f twoquestions.out -rm -f noquestions.out +rm -f nametoolong.out +rm -f twoquestions.out +rm -f noquestions.out rm -f ns*/named.conf rm -f ns*/named.lock rm -f ns*/named.run diff --git a/bin/tests/system/formerr/formerr.pl b/bin/tests/system/formerr/formerr.pl index 0c68274d98..fd7d298a9d 100644 --- a/bin/tests/system/formerr/formerr.pl +++ b/bin/tests/system/formerr/formerr.pl @@ -16,7 +16,7 @@ # the standard input, in the form of a series of bytes in hexadecimal. # Whitespace is ignored, as is anything following a '#' symbol. # -# For example, the following input would generate normal query for +# For example, the following input would generate normal query for # isc.org/NS/IN": # # # QID: diff --git a/bin/tests/system/forward/CA/certs/srv02.crt01.example.nil.pem b/bin/tests/system/forward/CA/certs/srv02.crt01.example.nil.pem index 27e8b3c13a..ea6030f648 100644 --- a/bin/tests/system/forward/CA/certs/srv02.crt01.example.nil.pem +++ b/bin/tests/system/forward/CA/certs/srv02.crt01.example.nil.pem @@ -41,11 +41,11 @@ Certificate: 87:aa:71:a8:6d:39:96:fe:e7:a9 Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv02.crt01.example.nil, IP Address:10.53.0.2 - X509v3 Subject Key Identifier: + X509v3 Subject Key Identifier: 70:90:94:81:4A:B2:BF:13:D6:29:1A:90:D9:33:A4:C5:74:29:CF:59 - X509v3 Authority Key Identifier: + X509v3 Authority Key Identifier: 7C:89:E8:5C:EB:E5:1F:72:48:04:C5:8F:FB:92:08:9C:F5:60:26:39 Signature Algorithm: sha256WithRSAEncryption Signature Value: diff --git a/bin/tests/system/forward/CA/certs/srv02.crt02-expired.example.nil.pem b/bin/tests/system/forward/CA/certs/srv02.crt02-expired.example.nil.pem index 8cae3b1204..455655d558 100644 --- a/bin/tests/system/forward/CA/certs/srv02.crt02-expired.example.nil.pem +++ b/bin/tests/system/forward/CA/certs/srv02.crt02-expired.example.nil.pem @@ -41,11 +41,11 @@ Certificate: 1f:2f:1a:15:15:cc:61:f3:b9:6f Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv02.crt02-expired.example.nil, IP Address:10.53.0.2 - X509v3 Subject Key Identifier: + X509v3 Subject Key Identifier: A7:8A:6D:EA:10:B4:6B:B8:13:16:6B:BA:A0:26:C3:9A:E7:A6:71:7E - X509v3 Authority Key Identifier: + X509v3 Authority Key Identifier: 7C:89:E8:5C:EB:E5:1F:72:48:04:C5:8F:FB:92:08:9C:F5:60:26:39 Signature Algorithm: sha256WithRSAEncryption Signature Value: diff --git a/bin/tests/system/forward/CA/certs/srv04.crt01.example.nil.pem b/bin/tests/system/forward/CA/certs/srv04.crt01.example.nil.pem index ca558fc483..7a8fbc1b66 100644 --- a/bin/tests/system/forward/CA/certs/srv04.crt01.example.nil.pem +++ b/bin/tests/system/forward/CA/certs/srv04.crt01.example.nil.pem @@ -41,11 +41,11 @@ Certificate: ff:1b:ad:59:35:c1:d1:d3:a6:ff Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv04.crt01.example.nil, IP Address:10.53.0.4 - X509v3 Subject Key Identifier: + X509v3 Subject Key Identifier: CA:83:06:FB:3E:57:50:DD:FD:BF:00:5A:60:E2:6D:98:71:CD:2C:F2 - X509v3 Authority Key Identifier: + X509v3 Authority Key Identifier: 7C:89:E8:5C:EB:E5:1F:72:48:04:C5:8F:FB:92:08:9C:F5:60:26:39 Signature Algorithm: sha256WithRSAEncryption Signature Value: diff --git a/bin/tests/system/forward/CA/newcerts/CCC118082632E18B.pem b/bin/tests/system/forward/CA/newcerts/CCC118082632E18B.pem index 27e8b3c13a..ea6030f648 100644 --- a/bin/tests/system/forward/CA/newcerts/CCC118082632E18B.pem +++ b/bin/tests/system/forward/CA/newcerts/CCC118082632E18B.pem @@ -41,11 +41,11 @@ Certificate: 87:aa:71:a8:6d:39:96:fe:e7:a9 Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv02.crt01.example.nil, IP Address:10.53.0.2 - X509v3 Subject Key Identifier: + X509v3 Subject Key Identifier: 70:90:94:81:4A:B2:BF:13:D6:29:1A:90:D9:33:A4:C5:74:29:CF:59 - X509v3 Authority Key Identifier: + X509v3 Authority Key Identifier: 7C:89:E8:5C:EB:E5:1F:72:48:04:C5:8F:FB:92:08:9C:F5:60:26:39 Signature Algorithm: sha256WithRSAEncryption Signature Value: diff --git a/bin/tests/system/forward/CA/newcerts/CCC118082632E18C.pem b/bin/tests/system/forward/CA/newcerts/CCC118082632E18C.pem index 8cae3b1204..455655d558 100644 --- a/bin/tests/system/forward/CA/newcerts/CCC118082632E18C.pem +++ b/bin/tests/system/forward/CA/newcerts/CCC118082632E18C.pem @@ -41,11 +41,11 @@ Certificate: 1f:2f:1a:15:15:cc:61:f3:b9:6f Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv02.crt02-expired.example.nil, IP Address:10.53.0.2 - X509v3 Subject Key Identifier: + X509v3 Subject Key Identifier: A7:8A:6D:EA:10:B4:6B:B8:13:16:6B:BA:A0:26:C3:9A:E7:A6:71:7E - X509v3 Authority Key Identifier: + X509v3 Authority Key Identifier: 7C:89:E8:5C:EB:E5:1F:72:48:04:C5:8F:FB:92:08:9C:F5:60:26:39 Signature Algorithm: sha256WithRSAEncryption Signature Value: diff --git a/bin/tests/system/forward/CA/newcerts/CCC118082632E18D.pem b/bin/tests/system/forward/CA/newcerts/CCC118082632E18D.pem index ca558fc483..7a8fbc1b66 100644 --- a/bin/tests/system/forward/CA/newcerts/CCC118082632E18D.pem +++ b/bin/tests/system/forward/CA/newcerts/CCC118082632E18D.pem @@ -41,11 +41,11 @@ Certificate: ff:1b:ad:59:35:c1:d1:d3:a6:ff Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv04.crt01.example.nil, IP Address:10.53.0.4 - X509v3 Subject Key Identifier: + X509v3 Subject Key Identifier: CA:83:06:FB:3E:57:50:DD:FD:BF:00:5A:60:E2:6D:98:71:CD:2C:F2 - X509v3 Authority Key Identifier: + X509v3 Authority Key Identifier: 7C:89:E8:5C:EB:E5:1F:72:48:04:C5:8F:FB:92:08:9C:F5:60:26:39 Signature Algorithm: sha256WithRSAEncryption Signature Value: diff --git a/bin/tests/system/genzone.sh b/bin/tests/system/genzone.sh index 3c8552a8e4..f436559772 100644 --- a/bin/tests/system/genzone.sh +++ b/bin/tests/system/genzone.sh @@ -96,7 +96,7 @@ hinfo02 HINFO PC NetBSD ; type 14 minfo01 MINFO rmailbx emailbx -minfo02 MINFO . . +minfo02 MINFO . . ; type 15 mx01 MX 10 mail @@ -121,7 +121,7 @@ txt15 TXT "bar\\;" ; type 17 rp01 RP mbox-dname txt-dname -rp02 RP . . +rp02 RP . . ; type 18 afsdb01 AFSDB 0 hostname @@ -154,7 +154,7 @@ nsap-ptr01 NSAP-PTR . ; type 24 ;sig01 SIG NXT 1 3 ( 3600 20000102030405 -; 19961211100908 2143 foo.nil. +; 19961211100908 2143 foo.nil. ; MxFcby9k/yvedMfQgKzhH5er0Mu/vILz45I ; kskceFGgiWCn/GxHhai6VAuHAoNUz4YoU1t ; VfSCSqQYn6//11U6Nld80jEeC8aTrO+KKmCaY= ) @@ -205,7 +205,7 @@ atma03 ATMA 1234567890abcdef atma04 ATMA f.e.d.c.b.a.0.9.8.7.6.5.4.3.2.1 ; type 35 -naptr01 NAPTR 0 0 "" "" "" . +naptr01 NAPTR 0 0 "" "" "" . naptr02 NAPTR 65535 65535 blurgh blorf blllbb foo. naptr02 NAPTR 65535 65535 "blurgh" "blorf" "blllbb" foo. @@ -214,7 +214,7 @@ kx01 KX 10 kdc kx02 KX 10 . ; type 37 -cert01 CERT 65534 65535 254 ( +cert01 CERT 65534 65535 254 ( MxFcby9k/yvedMfQgKzhH5er0Mu/vILz45I kskceFGgiWCn/GxHhai6VAuHAoNUz4YoU1t VfSCSqQYn6//11U6Nld80jEeC8aTrO+KKmCaY= ) @@ -266,7 +266,7 @@ ipseckey05 IPSECKEY ( 10 2 2 ; type 46 rrsig01 RRSIG NSEC 1 3 ( 3600 20000102030405 - 19961211100908 2143 foo.nil. + 19961211100908 2143 foo.nil. MxFcby9k/yvedMfQgKzhH5er0Mu/vILz45I kskceFGgiWCn/GxHhai6VAuHAoNUz4YoU1t VfSCSqQYn6//11U6Nld80jEeC8aTrO+KKmCaY= ) @@ -503,7 +503,7 @@ svcb1 SVCB 1 . port=60 ; keydata (internal type used for managed keys) keydata TYPE65533 \# 0 -keydata TYPE65533 \# 6 010203040506 +keydata TYPE65533 \# 6 010203040506 keydata TYPE65533 \# 18 010203040506010203040506010203040506 ; type 65535 (reserved) diff --git a/bin/tests/system/inline/ns3/sign.sh b/bin/tests/system/inline/ns3/sign.sh index a4c9e14221..f17a8ad1a3 100755 --- a/bin/tests/system/inline/ns3/sign.sh +++ b/bin/tests/system/inline/ns3/sign.sh @@ -148,11 +148,11 @@ do $DSFROMKEY -T 1200 $k4 >> ../ns1/root.db # Convert k1 and k2 in to External Keys. - rm -f $k1.private + rm -f $k1.private mv $k1.key a-file $IMPORTKEY -P now -D now+3600 -f a-file $zone > /dev/null 2>&1 || ( echo_i "importkey failed: $alg" ) - rm -f $k2.private + rm -f $k2.private mv $k2.key a-file $IMPORTKEY -f a-file $zone > /dev/null 2>&1 || ( echo_i "importkey failed: $alg" ) diff --git a/bin/tests/system/legacy/ns6/sign.sh b/bin/tests/system/legacy/ns6/sign.sh index 39288fde2e..9baecad2cd 100755 --- a/bin/tests/system/legacy/ns6/sign.sh +++ b/bin/tests/system/legacy/ns6/sign.sh @@ -22,7 +22,7 @@ infile=edns512.db.in zonefile=edns512.db outfile=edns512.db.signed -keyname1=`$KEYGEN -a RSASHA512 -b 4096 -n zone $zone 2> /dev/null` +keyname1=`$KEYGEN -a RSASHA512 -b 4096 -n zone $zone 2> /dev/null` keyname2=`$KEYGEN -f KSK -a RSASHA512 -b 4096 -n zone $zone 2> /dev/null` cat $infile $keyname1.key $keyname2.key >$zonefile diff --git a/bin/tests/system/legacy/ns7/sign.sh b/bin/tests/system/legacy/ns7/sign.sh index fe994e601d..6356fa485a 100755 --- a/bin/tests/system/legacy/ns7/sign.sh +++ b/bin/tests/system/legacy/ns7/sign.sh @@ -22,7 +22,7 @@ infile=edns512-notcp.db.in zonefile=edns512-notcp.db outfile=edns512-notcp.db.signed -keyname1=`$KEYGEN -a RSASHA512 -b 4096 -n zone $zone 2> /dev/null` +keyname1=`$KEYGEN -a RSASHA512 -b 4096 -n zone $zone 2> /dev/null` keyname2=`$KEYGEN -f KSK -a RSASHA512 -b 4096 -n zone $zone 2> /dev/null` cat $infile $keyname1.key $keyname2.key >$zonefile diff --git a/bin/tests/system/metadata/clean.sh b/bin/tests/system/metadata/clean.sh index 58cd7cec15..bac7f18c37 100644 --- a/bin/tests/system/metadata/clean.sh +++ b/bin/tests/system/metadata/clean.sh @@ -12,7 +12,7 @@ # information regarding copyright ownership. rm -f K* dsset-* *.signed *.new -rm -f zsk.key ksk.key parent.ksk.key parent.zsk.key +rm -f zsk.key ksk.key parent.ksk.key parent.zsk.key rm -f pending.key rolling.key standby.key inact.key rm -f prerev.key postrev.key oldstyle.key rm -f keys sigs diff --git a/bin/tests/system/nsupdate/CA/certs/srv01.client01.example.nil.pem b/bin/tests/system/nsupdate/CA/certs/srv01.client01.example.nil.pem index f546d35e7d..f32b4c4f2c 100644 --- a/bin/tests/system/nsupdate/CA/certs/srv01.client01.example.nil.pem +++ b/bin/tests/system/nsupdate/CA/certs/srv01.client01.example.nil.pem @@ -40,7 +40,7 @@ Certificate: 42:89:b8:e3:f8:b1:24:08:7e:99 Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client01.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 07:97:69:51:12:50:6a:e1:02:a0:b0:dc:93:75:16:c4:38:0f: diff --git a/bin/tests/system/nsupdate/CA/certs/srv01.client02-expired.example.nil.pem b/bin/tests/system/nsupdate/CA/certs/srv01.client02-expired.example.nil.pem index 365b493f7e..bbdb6dea6f 100644 --- a/bin/tests/system/nsupdate/CA/certs/srv01.client02-expired.example.nil.pem +++ b/bin/tests/system/nsupdate/CA/certs/srv01.client02-expired.example.nil.pem @@ -40,7 +40,7 @@ Certificate: af:8d:0c:fb:7c:ea:c7:73:9c:9b Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client02-expired.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 18:f1:7c:24:5b:d2:03:b0:60:0e:60:e6:32:f9:a7:47:d1:e4: diff --git a/bin/tests/system/nsupdate/CA/certs/srv01.crt01.example.nil.pem b/bin/tests/system/nsupdate/CA/certs/srv01.crt01.example.nil.pem index 4a4556c2b0..e08666bac3 100644 --- a/bin/tests/system/nsupdate/CA/certs/srv01.crt01.example.nil.pem +++ b/bin/tests/system/nsupdate/CA/certs/srv01.crt01.example.nil.pem @@ -40,7 +40,7 @@ Certificate: 74:ab:fb:cc:a3:5d:a6:84:80:0b Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt01.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 94:15:c0:4a:f1:aa:15:30:f7:cb:fe:f9:fa:ba:5f:f0:18:1f: diff --git a/bin/tests/system/nsupdate/CA/certs/srv01.crt02-expired.example.nil.pem b/bin/tests/system/nsupdate/CA/certs/srv01.crt02-expired.example.nil.pem index 3fa0b9ae88..9a407f673b 100644 --- a/bin/tests/system/nsupdate/CA/certs/srv01.crt02-expired.example.nil.pem +++ b/bin/tests/system/nsupdate/CA/certs/srv01.crt02-expired.example.nil.pem @@ -40,7 +40,7 @@ Certificate: 76:74:77:ce:3d:4d:fe:02:b1:33 Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt02-expired.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 2a:52:c4:cb:a9:2f:f7:2b:ed:04:b5:03:d5:06:59:ed:5c:7c: diff --git a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19598.pem b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19598.pem index 4a4556c2b0..e08666bac3 100644 --- a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19598.pem +++ b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19598.pem @@ -40,7 +40,7 @@ Certificate: 74:ab:fb:cc:a3:5d:a6:84:80:0b Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt01.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 94:15:c0:4a:f1:aa:15:30:f7:cb:fe:f9:fa:ba:5f:f0:18:1f: diff --git a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19599.pem b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19599.pem index 3fa0b9ae88..9a407f673b 100644 --- a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19599.pem +++ b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA19599.pem @@ -40,7 +40,7 @@ Certificate: 76:74:77:ce:3d:4d:fe:02:b1:33 Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.crt02-expired.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 2a:52:c4:cb:a9:2f:f7:2b:ed:04:b5:03:d5:06:59:ed:5c:7c: diff --git a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959A.pem b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959A.pem index f546d35e7d..f32b4c4f2c 100644 --- a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959A.pem +++ b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959A.pem @@ -40,7 +40,7 @@ Certificate: 42:89:b8:e3:f8:b1:24:08:7e:99 Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client01.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 07:97:69:51:12:50:6a:e1:02:a0:b0:dc:93:75:16:c4:38:0f: diff --git a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959B.pem b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959B.pem index 365b493f7e..bbdb6dea6f 100644 --- a/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959B.pem +++ b/bin/tests/system/nsupdate/CA/newcerts/70B9F4EB2FA1959B.pem @@ -40,7 +40,7 @@ Certificate: af:8d:0c:fb:7c:ea:c7:73:9c:9b Exponent: 65537 (0x10001) X509v3 extensions: - X509v3 Subject Alternative Name: + X509v3 Subject Alternative Name: DNS:srv01.client02-expired.example.nil, IP Address:10.53.0.1 Signature Algorithm: sha256WithRSAEncryption 18:f1:7c:24:5b:d2:03:b0:60:0e:60:e6:32:f9:a7:47:d1:e4: diff --git a/bin/tests/system/pending/ns1/sign.sh b/bin/tests/system/pending/ns1/sign.sh index 13a6b0f4f4..cb3662fe53 100644 --- a/bin/tests/system/pending/ns1/sign.sh +++ b/bin/tests/system/pending/ns1/sign.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/sh # Copyright (C) Internet Systems Consortium, Inc. ("ISC") # diff --git a/bin/tests/system/resolver/tests.sh b/bin/tests/system/resolver/tests.sh index f6acafeb01..2af36cc86e 100755 --- a/bin/tests/system/resolver/tests.sh +++ b/bin/tests/system/resolver/tests.sh @@ -163,7 +163,7 @@ do # Expected queries = 2 * number of NS records, up to a maximum of 10. expected=$((nscount*2)) if [ "$expected" -gt 10 ]; then expected=10; fi - # Count the number of logged fetches + # Count the number of logged fetches nextpart ns5/named.run > /dev/null dig_with_opts @10.53.0.5 target${nscount}.sourcens A > dig.ns5.out.${nscount}.${n} || ret=1 retry_quiet 5 count_fetches ns5/named.run $nscount $expected || { diff --git a/bin/tests/system/rndc/ns6/named.args b/bin/tests/system/rndc/ns6/named.args index 9d7d03aaac..331f7f4125 100644 --- a/bin/tests/system/rndc/ns6/named.args +++ b/bin/tests/system/rndc/ns6/named.args @@ -1,3 +1,3 @@ -# teardown of a huge zone with tracing enabled takes way too long +# teardown of a huge zone with tracing enabled takes way too long # -m none is set so that stop.pl does not timeout -D rndc-ns6 -X named.lock -m none -c named.conf -d 99 -g -U 4 -T maxcachesize=2097152 diff --git a/bin/tests/system/rrl/tests.sh b/bin/tests/system/rrl/tests.sh index 2069a4246f..85636aacf0 100644 --- a/bin/tests/system/rrl/tests.sh +++ b/bin/tests/system/rrl/tests.sh @@ -118,23 +118,23 @@ ck_result() { NXDOMAIN=`grep -E "^NXDOMAIN|NXDOMAINTC$" mdig.out-$1 2>/dev/null | wc -l` SERVFAIL=`grep -E "^SERVFAIL$" mdig.out-$1 2>/dev/null | wc -l` NOERROR=`grep -E "^NOERROR$" mdig.out-$1 2>/dev/null | wc -l` - + range $ADDRS "$3" 1 || setret "$ADDRS instead of $3 '$2' responses for $1" && BAD=yes - + range $TC "$4" 1 || setret "$TC instead of $4 truncation responses for $1" && BAD=yes - + range $DROP "$5" 1 || setret "$DROP instead of $5 dropped responses for $1" && BAD=yes - + range $NXDOMAIN "$6" 1 || setret "$NXDOMAIN instead of $6 NXDOMAIN responses for $1" && BAD=yes - + range $SERVFAIL "$7" 1 || setret "$SERVFAIL instead of $7 error responses for $1" && BAD=yes @@ -142,7 +142,7 @@ ck_result() { range $NOERROR "$8" 1 || setret "$NOERROR instead of $8 NOERROR responses for $1" && BAD=yes - + if test -z "$BAD"; then rm -f mdig.out-$1 fi @@ -157,7 +157,7 @@ ckstats () { sed -n -e "s/[ ]*\([0-9]*\).responses $TYPE for rate limits.*/\1/p" | tail -1` C=`expr 0$C + 0` - + range "$C" $EXPECTED 1 || setret "wrong $LABEL $TYPE statistics of $C instead of $EXPECTED" } diff --git a/bin/tests/system/rsabigexponent/ns1/root.db.in b/bin/tests/system/rsabigexponent/ns1/root.db.in index 048632546a..a85d814174 100644 --- a/bin/tests/system/rsabigexponent/ns1/root.db.in +++ b/bin/tests/system/rsabigexponent/ns1/root.db.in @@ -15,7 +15,7 @@ $TTL 300 3600 ; refresh 1200 ; retry 604800 ; expire - 60 ; minimum + 60 ; minimum ) @ NS a.root-servers.nil. a.root-servers.nil. A 10.53.0.1 diff --git a/bin/tests/system/runtime/setup.sh b/bin/tests/system/runtime/setup.sh index 2bcfd0348b..f6747ce51a 100644 --- a/bin/tests/system/runtime/setup.sh +++ b/bin/tests/system/runtime/setup.sh @@ -13,7 +13,7 @@ . ../conf.sh -$SHELL clean.sh +$SHELL clean.sh copy_setports ns2/named1.conf.in ns2/named.conf diff --git a/bin/tests/system/staticstub/ns3/sign.sh b/bin/tests/system/staticstub/ns3/sign.sh index 168dfa2a35..9d87137383 100755 --- a/bin/tests/system/staticstub/ns3/sign.sh +++ b/bin/tests/system/staticstub/ns3/sign.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/sh # Copyright (C) Internet Systems Consortium, Inc. ("ISC") # diff --git a/bin/tests/system/stop.pl b/bin/tests/system/stop.pl index 9c6a39a84e..cb35af3afd 100644 --- a/bin/tests/system/stop.pl +++ b/bin/tests/system/stop.pl @@ -195,7 +195,7 @@ sub stop_rndc { sub server_died { my ( $server, $signal ) = @_; - + print "I:$test:$server died before a SIG$signal was sent\n"; $errors = 1; diff --git a/bin/tests/system/stress/setup.pl b/bin/tests/system/stress/setup.pl index 947defb33b..18a4246b29 100644 --- a/bin/tests/system/stress/setup.pl +++ b/bin/tests/system/stress/setup.pl @@ -43,11 +43,11 @@ for ($z = 0; $z < $n_zones; $z++) { my $zn = sprintf("zone%06d.example", $z); foreach $ns (qw(2 3 4)) { print $rootdelegations "$zn. NS ns$ns.$zn.\n"; - print $rootdelegations "ns$ns.$zn. A 10.53.0.$ns\n"; + print $rootdelegations "ns$ns.$zn. A 10.53.0.$ns\n"; } } close $rootdelegations; - + sub make_zones { my ($nsno, $secondaried_from) = @_; my $namedconf = new FileHandle("ns$nsno/zones.conf", "w") or die; diff --git a/bin/tests/system/tsig/tests.sh b/bin/tests/system/tsig/tests.sh index ee05e838c1..da85e7d622 100644 --- a/bin/tests/system/tsig/tests.sh +++ b/bin/tests/system/tsig/tests.sh @@ -154,7 +154,7 @@ fi # if $FEATURETEST --md5 then - echo_i "fetching using hmac-md5-80 (BADTRUNC)" + echo_i "fetching using hmac-md5-80 (BADTRUNC)" ret=0 $DIG $DIGOPTS example.nil. -y "hmac-md5-80:md5:$md5" @10.53.0.1 soa > dig.out.md5-80 || ret=1 grep -i "md5.*TSIG.*BADTRUNC" dig.out.md5-80 > /dev/null || ret=1 @@ -162,7 +162,7 @@ then echo_i "failed"; status=1 fi else - echo_i "skipping using hmac-md5-80 (BADTRUNC)" + echo_i "skipping using hmac-md5-80 (BADTRUNC)" fi echo_i "fetching using hmac-sha1-80 (BADTRUNC)" diff --git a/bin/tests/system/tsiggss/ns1/example.nil.db.in b/bin/tests/system/tsiggss/ns1/example.nil.db.in index 536ef292b9..ffa7e588e9 100644 --- a/bin/tests/system/tsiggss/ns1/example.nil.db.in +++ b/bin/tests/system/tsiggss/ns1/example.nil.db.in @@ -10,7 +10,7 @@ ; information regarding copyright ownership. ; -*- zone -*- -; this was generated by a Samba4 provision, and is typical +; this was generated by a Samba4 provision, and is typical ; of a AD DNS zone $ORIGIN example.nil. $TTL 1W diff --git a/bin/tests/system/upforwd/ans4/ans.pl b/bin/tests/system/upforwd/ans4/ans.pl index 75ab3ed0f1..000be5636c 100644 --- a/bin/tests/system/upforwd/ans4/ans.pl +++ b/bin/tests/system/upforwd/ans4/ans.pl @@ -156,7 +156,7 @@ sub handleUDP { $tsig->{"request_mac"} = unpack("H*", $rmac); } - + $packet->sign_tsig($tsig); } last; @@ -258,10 +258,10 @@ sub handleTCP { ($packet, $err) = new Net::DNS::Packet(\$buf, 0); $err and die $err; } - + $packet->header->qr(1); $packet->header->aa(1); - + my @questions = $packet->question; my $qname = $questions[0]->qname; my $qtype = $questions[0]->qtype; @@ -291,7 +291,7 @@ sub handleTCP { } if(defined($key_name) && defined($key_data)) { # sign the packet - print " Signing the data with " . + print " Signing the data with " . "$key_name/$key_data\n"; my $tsig = Net::DNS::RR-> @@ -314,7 +314,7 @@ sub handleTCP { $tsig->{"request_mac"} = unpack("H*", $rmac); } - + $tsig->sign_func($signer) if defined($signer); $packet->sign_tsig($tsig); $signer = \&sign_tcp_continuation; diff --git a/bin/tests/system/zonechecks/tests.sh b/bin/tests/system/zonechecks/tests.sh index dbd607eac2..59b41ccbc1 100644 --- a/bin/tests/system/zonechecks/tests.sh +++ b/bin/tests/system/zonechecks/tests.sh @@ -160,7 +160,7 @@ fi # echo_i "checking 'rdnc zonestatus' output" -ret=0 +ret=0 for i in 0 1 2 3 4 5 6 7 8 9 do $RNDCCMD 10.53.0.1 zonestatus primary.example > rndc.out.pri 2>&1 @@ -235,7 +235,7 @@ if [ $ret != 0 ]; then echo_i "failed"; fi status=`expr $status + $ret` echo_i "checking 'rdnc zonestatus' with duplicated zone name" -ret=0 +ret=0 $RNDCCMD 10.53.0.1 zonestatus duplicate.example > rndc.out.duplicate 2>&1 checkfor "zone 'duplicate.example' was found in multiple views" rndc.out.duplicate $RNDCCMD 10.53.0.1 zonestatus duplicate.example in primary > rndc.out.duplicate 2>&1 diff --git a/contrib/README b/contrib/README index 65be3427dd..5f0682b302 100644 --- a/contrib/README +++ b/contrib/README @@ -17,7 +17,7 @@ be fixed as time permits. - scripts/ - Assorted useful scripts, including 'nanny' which monitors + Assorted useful scripts, including 'nanny' which monitors named and restarts it in the event of a crash, 'zone-edit' which enables editing of a dynamic zone, and others. diff --git a/contrib/dlz/modules/bdbhpt/testing/bdbhpt-populate.pl b/contrib/dlz/modules/bdbhpt/testing/bdbhpt-populate.pl index b2bceba4e6..f71f783e14 100755 --- a/contrib/dlz/modules/bdbhpt/testing/bdbhpt-populate.pl +++ b/contrib/dlz/modules/bdbhpt/testing/bdbhpt-populate.pl @@ -65,10 +65,10 @@ foreach my $zone (@zones) { my $ttl = $r->{ttl}; my $type = $r->{type}; my $data = $r->{data}; - + $data =~ s/\%zone\%/$zone/g; $data =~ s/\%driver\%/bdbhpt-dynamic/g; - + my $row_name = "$zone $name"; my $row_value = "$replId $name $ttl $type $data"; if ($dns_data->db_put($row_name, $row_value) != 0) { @@ -183,7 +183,7 @@ sub validate_record { foreach my $t (@TYPES) { $VALID_TYPE->{$t} = 1; } - + if (!defined $r->{name} || $r->{name} eq '') { die "Record name must be set"; } diff --git a/contrib/dlz/modules/ldap/testing/slapd.conf b/contrib/dlz/modules/ldap/testing/slapd.conf index 14c8ffb02a..d4a62874ac 100644 --- a/contrib/dlz/modules/ldap/testing/slapd.conf +++ b/contrib/dlz/modules/ldap/testing/slapd.conf @@ -21,12 +21,12 @@ database hdb # This is the root of the LDAP server. You still need to add # an entry to this location via a LDIF file, or you won't be -# able to add anything else into the LDAP server. +# able to add anything else into the LDAP server. suffix "o=bind-dlz" # this is the "username" you have to use when connecting to the # ldap server to make updates. Type the whole thing exactly -# as you see it as a parameter to ldapadd. +# as you see it as a parameter to ldapadd. rootdn "cn=Manager,o=bind-dlz" # this is the "password" you have to use when connecting to the diff --git a/contrib/dlz/modules/mysqldyn/README b/contrib/dlz/modules/mysqldyn/README index 6faa35de50..7f93c244cb 100644 --- a/contrib/dlz/modules/mysqldyn/README +++ b/contrib/dlz/modules/mysqldyn/README @@ -73,7 +73,7 @@ The database for this module uses the following schema: - writeable: set to true if the zone can be updated via DDNS 'ZoneData' contains the individual records within the zone: - - zone_id: the 'id' from the corresponding record in Zones + - zone_id: the 'id' from the corresponding record in Zones - name: domain name, relative to the zone apex. (Data at the zone apex itself may use a blank name or "@".) - type: the RR type, expressed as text diff --git a/contrib/scripts/zone-edit.sh.in b/contrib/scripts/zone-edit.sh.in index ad9c5fa16a..2596ef8d18 100644 --- a/contrib/scripts/zone-edit.sh.in +++ b/contrib/scripts/zone-edit.sh.in @@ -72,8 +72,8 @@ then then if ${checkzone} -q -D "$zone" ${dir}/new > ${dir}/nnn then - sort ${dir}/ooo > ${dir}/s1 - sort ${dir}/nnn > ${dir}/s2 + sort ${dir}/ooo > ${dir}/s1 + sort ${dir}/nnn > ${dir}/s2 comm -23 ${dir}/s1 ${dir}/s2 | sed 's/^/update delete /' > ${dir}/ccc comm -13 ${dir}/s1 ${dir}/s2 | @@ -111,7 +111,7 @@ then done else while : - do + do echo ${echo_arg} "Abort (a), Redo (r), Modify (m) : $bsc" read ans case "$ans" in @@ -130,7 +130,7 @@ then fi else while : - do + do echo ${echo_arg} "Abort (a), Redo (r), Modify (m) : $bsc" read ans case "$ans" in diff --git a/doc/arm/dns-ops.inc.rst b/doc/arm/dns-ops.inc.rst index 38effae7e0..abb6bcf766 100644 --- a/doc/arm/dns-ops.inc.rst +++ b/doc/arm/dns-ops.inc.rst @@ -19,7 +19,7 @@ Name Server Operations Tools for Use With the Name Server Daemon ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes several indispensable diagnostic, administrative, +This section describes several indispensable diagnostic, administrative, and monitoring tools available to the system administrator for controlling and debugging the name server daemon. diff --git a/doc/arm/intro-dns-bind.inc.rst b/doc/arm/intro-dns-bind.inc.rst index f8a61c4c43..58b0d2952c 100644 --- a/doc/arm/intro-dns-bind.inc.rst +++ b/doc/arm/intro-dns-bind.inc.rst @@ -14,14 +14,14 @@ The Domain Name System (DNS) ---------------------------- -This is a brief description of the functionality and organization of the Domain Name System (DNS). -It is provided to familiarize users with the concepts involved, the (often confusing) terminology -used, and how all the parts fit together to form an operational system. +This is a brief description of the functionality and organization of the Domain Name System (DNS). +It is provided to familiarize users with the concepts involved, the (often confusing) terminology +used, and how all the parts fit together to form an operational system. -All network systems operate with network addresses, such as IPv4 and IPv6. The vast majority of -humans find it easier to work with names rather than seemingly endless strings of network address digits. The earliest ARPANET systems -(from which the Internet evolved) mapped names to addresses using a **hosts** file that was distributed to all entities -whenever changes occurred. Operationally, such a system became rapidly unsustainable once there were more +All network systems operate with network addresses, such as IPv4 and IPv6. The vast majority of +humans find it easier to work with names rather than seemingly endless strings of network address digits. The earliest ARPANET systems +(from which the Internet evolved) mapped names to addresses using a **hosts** file that was distributed to all entities +whenever changes occurred. Operationally, such a system became rapidly unsustainable once there were more than 100 networked entities, which led to the specification and implementation of the Domain Name System that we use today. .. _dns_fundamentals: @@ -29,16 +29,16 @@ than 100 networked entities, which led to the specification and implementation o DNS Fundamentals ~~~~~~~~~~~~~~~~ -The DNS naming system is organized as a tree structure comprised of multiple levels and -thus it naturally creates a distributed system. Each node -in the tree is given a label which defines its **Domain** (its area or zone) of **Authority**. +The DNS naming system is organized as a tree structure comprised of multiple levels and +thus it naturally creates a distributed system. Each node +in the tree is given a label which defines its **Domain** (its area or zone) of **Authority**. The topmost node in the tree is the **Root Domain**; it delegates to **Domains** at the next level which are generically -known as the **Top-Level Domains (TLDs)**. They in turn delegate to **Second-Level Domains (SLDs)**, and so on. +known as the **Top-Level Domains (TLDs)**. They in turn delegate to **Second-Level Domains (SLDs)**, and so on. The Top-Level Domains (TLDs) include a special group of TLDs called the **Country Code Top-Level Domains (ccTLDs)**, in which every country is assigned a unique two-character country code from ISO 3166 as its domain. -.. Note:: The Domain Name System is controlled by ICANN (https://www.icann.org) (a 501c non-profit entity); their current policy - is that any new TLD, consisting of three or more characters, may be proposed by any group of commercial sponsors and +.. Note:: The Domain Name System is controlled by ICANN (https://www.icann.org) (a 501c non-profit entity); their current policy + is that any new TLD, consisting of three or more characters, may be proposed by any group of commercial sponsors and if it meets ICANN's criteria will be added to the TLDs. The concept of delegation and authority flows down the DNS tree (the DNS hierarchy) as shown: @@ -48,7 +48,7 @@ The concept of delegation and authority flows down the DNS tree (the DNS hierarc Delegation and Authority in the DNS Name Space -A domain is the label of a node in the tree. A **domain name** uniquely identifies any node in the DNS tree and is written, left to right, +A domain is the label of a node in the tree. A **domain name** uniquely identifies any node in the DNS tree and is written, left to right, by combining all the domain labels (each of which are unique within their parent's zone or domain of authority), with a dot separating each component, up to the root domain. In the above diagram the following are all domain names: @@ -60,7 +60,7 @@ separating each component, up to the root domain. In the above diagram the follo us org -The root has a unique label of "." (dot), which is normally omitted when it is written as +The root has a unique label of "." (dot), which is normally omitted when it is written as a domain name, but when it is written as a **Fully Qualified Domain Name (FQDN)** the dot must be present. Thus: .. code-block:: @@ -71,11 +71,11 @@ a domain name, but when it is written as a **Fully Qualified Domain Name (FQDN)* Authority and Delegation ~~~~~~~~~~~~~~~~~~~~~~~~ -Each domain (node) has been **delegated** the authority from its parent domain. The delegated authority includes -specific responsibilities to ensure that every domain it delegates has a unique name or label within its zone or domain of authority, and -that it maintains an **authoritative** list of its delegated domains. The responsibilities further include an operational requirement to -operate two (or more) name servers (which may be contracted to a third party) which will contain the authoritative data -for all the domain labels within its zone of authority in a :ref:`zone file`. Again, the +Each domain (node) has been **delegated** the authority from its parent domain. The delegated authority includes +specific responsibilities to ensure that every domain it delegates has a unique name or label within its zone or domain of authority, and +that it maintains an **authoritative** list of its delegated domains. The responsibilities further include an operational requirement to +operate two (or more) name servers (which may be contracted to a third party) which will contain the authoritative data +for all the domain labels within its zone of authority in a :ref:`zone file`. Again, the tree structure ensures that the DNS name space is naturally distributed. The following diagram illustrates that **Authoritative Name Servers** exist for every level and every domain in the DNS name space: @@ -85,8 +85,8 @@ The following diagram illustrates that **Authoritative Name Servers** exist for Authoritative Name Servers in the DNS Name Space -.. Note:: The difference between a domain and a zone can appear confusing. Practically, the terms are generally used synonymously in the DNS. - If, however, you are into directed graphs and tree structure theory or similar exotica, a zone can be considered as +.. Note:: The difference between a domain and a zone can appear confusing. Practically, the terms are generally used synonymously in the DNS. + If, however, you are into directed graphs and tree structure theory or similar exotica, a zone can be considered as an arc through any node (or domain) with the domain at its apex. The zone therefore encompasses all the name space below the domain. This can, however, lead to the concept of subzones and these were indeed defined in the original DNS specifications. Thankfully the term subzone has been lost in the mists of time. @@ -96,35 +96,35 @@ The following diagram illustrates that **Authoritative Name Servers** exist for Root Servers ~~~~~~~~~~~~ -The **root servers** are a critical part of the DNS authoritative infrastructure. There are 13 root servers (*a.root-servers.net* -to *m.root-servers.net*). The number 13 is historically based on the maximum amount of name and IPv4 data +The **root servers** are a critical part of the DNS authoritative infrastructure. There are 13 root servers (*a.root-servers.net* +to *m.root-servers.net*). The number 13 is historically based on the maximum amount of name and IPv4 data that could be packed into a 512-byte UDP message, and not a perverse affinity for a number that certain -cultures treat as unlucky. The 512-byte UDP data limit +cultures treat as unlucky. The 512-byte UDP data limit is no longer a limiting factor and all root servers now support both IPv4 and IPv6. In addition, almost all the -root servers use **anycast**, with well over -300 instances of the root servers now providing service worldwide (see further information at https://www.root-servers.org). +root servers use **anycast**, with well over +300 instances of the root servers now providing service worldwide (see further information at https://www.root-servers.org). The root servers are the starting point for all **name resolution** within the DNS. Name Resolution ~~~~~~~~~~~~~~~ -So far all the emphasis has been on how the DNS stores its authoritative domain (zone) data. End-user systems -use names (an email address or a web address) and need to access this authoritative data to obtain an IP address, which -they use to contact the required network resources such as web, FTP, or mail servers. The process of converting a -domain name to a result (typically an IP address, though other types of data may be obtained) is generically called **name resolution**, and is handled by -**resolvers** (also known as **caching name servers** and many other terms). The following diagram shows the typical name resolution process: +So far all the emphasis has been on how the DNS stores its authoritative domain (zone) data. End-user systems +use names (an email address or a web address) and need to access this authoritative data to obtain an IP address, which +they use to contact the required network resources such as web, FTP, or mail servers. The process of converting a +domain name to a result (typically an IP address, though other types of data may be obtained) is generically called **name resolution**, and is handled by +**resolvers** (also known as **caching name servers** and many other terms). The following diagram shows the typical name resolution process: .. figure:: name-resolution.png :align: center Authoritative Name Servers and Name Resolution -An end-user application, such as a browser (1), when needing to resolve a name such as **www.example.com**, makes an -internal system call to a minimal function resolution entity called a **stub resolver** (2). The stub resolver (using stored -IP addresses) contacts a resolver (a caching name server or full-service resolver) (3), which in turn contacts all the necessary +An end-user application, such as a browser (1), when needing to resolve a name such as **www.example.com**, makes an +internal system call to a minimal function resolution entity called a **stub resolver** (2). The stub resolver (using stored +IP addresses) contacts a resolver (a caching name server or full-service resolver) (3), which in turn contacts all the necessary authoritative name servers (4, 5, and 6) to provide the answer that it then returns to the user (2, 1). To improve performance, -all resolvers (including most stub resolvers) cache (store) their results such that a subsequent request for the same data -is taken from the resolver's cache, removing the need to repeat the name resolution process and use time-consuming resources. All communication between +all resolvers (including most stub resolvers) cache (store) their results such that a subsequent request for the same data +is taken from the resolver's cache, removing the need to repeat the name resolution process and use time-consuming resources. All communication between the stub resolver, the resolver, and the authoritative name servers uses the DNS protocol's query and response message pair. .. _referral: @@ -136,7 +136,7 @@ the stub resolver, the resolver, and the authoritative name servers uses the DNS DNS Protocol and Queries ~~~~~~~~~~~~~~~~~~~~~~~~ -DNS **queries** use the UDP protocol over the reserved port 53 (but both TCP and TLS can optionally be used in some parts of the network). +DNS **queries** use the UDP protocol over the reserved port 53 (but both TCP and TLS can optionally be used in some parts of the network). The following diagram shows the name resolution process expressed in terms of DNS queries and responses. @@ -145,7 +145,7 @@ The following diagram shows the name resolution process expressed in terms of DN Resolvers and Queries -The stub resolver sends a **recursive query** message (with the required domain name in the QUESTION section of the query) (2) to the resolver. +The stub resolver sends a **recursive query** message (with the required domain name in the QUESTION section of the query) (2) to the resolver. A **recursive** query simply requests the resolver to find the complete answer. A stub resolver only ever sends recursive queries and always needs the service of a resolver. The response to a recursive query can be: @@ -153,8 +153,8 @@ and always needs the service of a resolver. The response to a recursive query ca 2. An error (such as NXDOMAIN - the name does not exist). -The resolver, on receipt of the user's recursive query, either responds immediately, if the ANSWER is in its cache, or accesses -the DNS hierarchy to obtain the answer. The resolver always starts with root servers and sends an **iterative query** (4, 5, and 6). The +The resolver, on receipt of the user's recursive query, either responds immediately, if the ANSWER is in its cache, or accesses +the DNS hierarchy to obtain the answer. The resolver always starts with root servers and sends an **iterative query** (4, 5, and 6). The response to an iterative query can be: 1. The answer to the resolver's QUESTION in the ANSWER section of the query response. @@ -164,19 +164,19 @@ and typically IP addresses in the ADDITIONAL section of the response). 3. An error (such as NXDOMAIN - the name does not exist). -If the response is either an answer or an error, these are returned immediately to the user (and cached for future use). If the response +If the response is either an answer or an error, these are returned immediately to the user (and cached for future use). If the response is a referral, the resolver needs to take additional action to respond to the user's recursive query. -A referral, in essence, indicates that the queried server does not know the answer (the ANSWER section of the response is empty), but it -refers the resolver to the authoritative name servers (in the AUTHORITY section of the response) which it knows about in the -domain name supplied in the QUESTION section of the query. Thus, if the QUESTION is for the domain name **www.example.com**, the root -server to which the iterative query was sent adds a list of the **.com authoritative name servers** in the AUTHORITY section. -The resolver selects one of the servers from the AUTHORITY section and sends an -iterative query to it. Similarly, the .com authoritative name servers send a referral containing a list of the **example.com** authoritative name servers. -This process continues down the DNS hierarchy until either an ANSWER or an error is received, at which point the user's original recursive query +A referral, in essence, indicates that the queried server does not know the answer (the ANSWER section of the response is empty), but it +refers the resolver to the authoritative name servers (in the AUTHORITY section of the response) which it knows about in the +domain name supplied in the QUESTION section of the query. Thus, if the QUESTION is for the domain name **www.example.com**, the root +server to which the iterative query was sent adds a list of the **.com authoritative name servers** in the AUTHORITY section. +The resolver selects one of the servers from the AUTHORITY section and sends an +iterative query to it. Similarly, the .com authoritative name servers send a referral containing a list of the **example.com** authoritative name servers. +This process continues down the DNS hierarchy until either an ANSWER or an error is received, at which point the user's original recursive query is sent a response. -.. Note:: The DNS hierarchy is always accessed starting at the root servers and working down; there is no concept of "up" in the DNS hierarchy. Clearly, +.. Note:: The DNS hierarchy is always accessed starting at the root servers and working down; there is no concept of "up" in the DNS hierarchy. Clearly, if the resolver has already cached the list of .com authoritative name servers and the user's recursive query QUESTION contains a domain name ending in .com, it can omit access to the root servers. However, that is simply an artifact (in this case a performance benefit) of caching and does not change the concept of top-down access within the DNS hierarchy. @@ -188,10 +188,10 @@ DNS and BIND 9 BIND 9 is a complete implementation of the DNS protocol. BIND 9 can be configured (using its ``named.conf`` file) as an authoritative name server, a resolver, and, on supported hosts, a stub resolver. While large operators -usually dedicate DNS servers to a single function per system, smaller operators will find that +usually dedicate DNS servers to a single function per system, smaller operators will find that BIND 9's flexible configuration features support multiple functions, such as a single DNS server acting as both an authoritative name server and a resolver. Example configurations of basic :ref:`authoritative name servers` and -:ref:`resolvers and forwarding resolvers`, as +:ref:`resolvers and forwarding resolvers`, as well as :ref:`advanced configurations` and :ref:`secure configurations`, are provided. diff --git a/doc/arm/intro-security.inc.rst b/doc/arm/intro-security.inc.rst index 40abef87c2..87db9701da 100644 --- a/doc/arm/intro-security.inc.rst +++ b/doc/arm/intro-security.inc.rst @@ -14,20 +14,20 @@ DNS Security Overview --------------------- -DNS is a communications protocol. All communications protocols are potentially +DNS is a communications protocol. All communications protocols are potentially vulnerable to both subversion and eavesdropping. It is important for -users to audit their exposure to the various threats within their operational environment and implement the -appropriate solutions. BIND 9, a specific implementation of the DNS protocol, -provides an extensive set of security features. The purpose of this section -is to help users to select from the range of available security features those +users to audit their exposure to the various threats within their operational environment and implement the +appropriate solutions. BIND 9, a specific implementation of the DNS protocol, +provides an extensive set of security features. The purpose of this section +is to help users to select from the range of available security features those required for their specific user environment. -A generic DNS network is shown below, followed by text descriptions. In general, -the further one goes from the left-hand side of the diagram, the more complex +A generic DNS network is shown below, followed by text descriptions. In general, +the further one goes from the left-hand side of the diagram, the more complex the implementation. -.. Note:: Historically, DNS data was regarded as public and security was - concerned, primarily, with ensuring the integrity of DNS data. DNS data privacy +.. Note:: Historically, DNS data was regarded as public and security was + concerned, primarily, with ensuring the integrity of DNS data. DNS data privacy is increasingly regarded as an important dimension of overall security, specifically :ref:`DNS over TLS`. .. figure:: dns-security-overview.png @@ -37,40 +37,40 @@ the implementation. The following notes refer to the numbered elements in the above diagram. -1. A variety of system administration techniques and methods may be used to secure -BIND 9's local environment, including :ref:`file permissions `, running +1. A variety of system administration techniques and methods may be used to secure +BIND 9's local environment, including :ref:`file permissions `, running BIND 9 in a :ref:`jail `, and the use of :ref:`Access_Control_Lists`. 2. The remote name daemon control (:ref:`rndc`) program allows the system -administrator to control the operation of a name server. The majority of BIND 9 packages -or ports come preconfigured with local (loopback address) security preconfigured. +administrator to control the operation of a name server. The majority of BIND 9 packages +or ports come preconfigured with local (loopback address) security preconfigured. If ``rndc`` is being invoked from a remote host, further configuration is required. -The ``nsupdate`` tool uses **Dynamic DNS (DDNS)** features and allows users to dynamically -change the contents of the zone file(s). ``nsupdate`` access and security may be controlled +The ``nsupdate`` tool uses **Dynamic DNS (DDNS)** features and allows users to dynamically +change the contents of the zone file(s). ``nsupdate`` access and security may be controlled using ``named.conf`` :ref:`statements or using TSIG or SIG(0) cryptographic methods `. -Clearly, if the remote hosts used for either ``rndc`` or DDNS lie within a network entirely +Clearly, if the remote hosts used for either ``rndc`` or DDNS lie within a network entirely under the user's control, the security threat may be regarded as non-existent. Any implementation requirements, therefore, depend on the site's security policy. -3. Zone transfer from a **primary** to one or more **secondary** authoritative name servers across a -public network carries risk. The zone transfer may be secured using +3. Zone transfer from a **primary** to one or more **secondary** authoritative name servers across a +public network carries risk. The zone transfer may be secured using ``named.conf`` :ref:`statements, TSIG cryptographic methods or TLS`. -Clearly, if the secondary authoritative name server(s) all lie within a network entirely -under the user's control, the security threat may be regarded as non-existent. Any implementation requirements +Clearly, if the secondary authoritative name server(s) all lie within a network entirely +under the user's control, the security threat may be regarded as non-existent. Any implementation requirements again depend on the site's security policy. -4. If the operator of an authoritative name server (primary or secondary) wishes to ensure that -DNS responses to user-initiated queries about the zone(s) for which they are responsible can only -have come from their server, that the data received by the user is the same as that sent, and that -non-existent names are genuine, then :ref:`DNSSEC` is the only solution. DNSSEC requires configuration -and operational changes both to the authoritative name servers and to any resolver which accesses +4. If the operator of an authoritative name server (primary or secondary) wishes to ensure that +DNS responses to user-initiated queries about the zone(s) for which they are responsible can only +have come from their server, that the data received by the user is the same as that sent, and that +non-existent names are genuine, then :ref:`DNSSEC` is the only solution. DNSSEC requires configuration +and operational changes both to the authoritative name servers and to any resolver which accesses those servers. -5. The typical Internet-connected end-user device (PCs, laptops, and even mobile phones) either has -a stub resolver or operates via a DNS proxy. A stub resolver requires the services of an area -or full-service resolver to completely answer user queries. Stub resolvers on the majority of PCs and laptops -typically have a caching capability to increase performance. At this time there are no standard stub resolvers or proxy +5. The typical Internet-connected end-user device (PCs, laptops, and even mobile phones) either has +a stub resolver or operates via a DNS proxy. A stub resolver requires the services of an area +or full-service resolver to completely answer user queries. Stub resolvers on the majority of PCs and laptops +typically have a caching capability to increase performance. At this time there are no standard stub resolvers or proxy DNS tools that implement DNSSEC. BIND 9 may be configured to provide such capability on supported Linux or Unix platforms. -:ref:`DNS over TLS ` may be configured to verify the integrity of the data between the stub resolver and -area (or full-service) resolver. However, unless the resolver and the Authoritative Name Server implements DNSSEC, end-to-end integrity (from +:ref:`DNS over TLS ` may be configured to verify the integrity of the data between the stub resolver and +area (or full-service) resolver. However, unless the resolver and the Authoritative Name Server implements DNSSEC, end-to-end integrity (from authoritative name server to stub resolver) cannot be guaranteed. diff --git a/doc/arm/introduction.inc.rst b/doc/arm/introduction.inc.rst index ebb7e7acc8..42d7110e34 100644 --- a/doc/arm/introduction.inc.rst +++ b/doc/arm/introduction.inc.rst @@ -42,7 +42,7 @@ Organization of This Document :ref:`introduction` introduces the basic DNS and BIND concepts. Some tutorial material on :ref:`dns_overview` is presented for those unfamiliar with DNS. A -:ref:`intro_dns_security` is provided to allow BIND operators to implement +:ref:`intro_dns_security` is provided to allow BIND operators to implement appropriate security for their operational environment. :ref:`requirements` describes the hardware and environment requirements for BIND 9 @@ -51,13 +51,13 @@ and lists both the supported and unsupported platforms. :ref:`configuration` is intended as a quickstart guide for newer users. Sample files are included for :ref:`config_auth_samples` (both :ref:`primary` and :ref:`secondary`), as well as a simple :ref:`config_resolver_samples` and -a :ref:`sample_forwarding`. Some reference material on the :ref:`Zone File` is included. +a :ref:`sample_forwarding`. Some reference material on the :ref:`Zone File` is included. :ref:`ns_operations` covers basic BIND 9 software and DNS operations, including some useful tools, Unix signals, and plugins. :ref:`advanced` builds on the configurations of :ref:`configuration`, adding -functions and features the system administrator may need. +functions and features the system administrator may need. :ref:`security` covers most aspects of BIND 9 security, including file permissions, running BIND 9 in a "jail," and securing file transfers and dynamic updates. @@ -65,14 +65,14 @@ running BIND 9 in a "jail," and securing file transfers and dynamic updates. :ref:`dnssec` describes the theory and practice of cryptographic authentication of DNS information. The :ref:`dnssec_guide` is a practical guide to implementing DNSSEC. -:ref:`Reference` gives exhaustive descriptions of all supported blocks, statements, +:ref:`Reference` gives exhaustive descriptions of all supported blocks, statements, and grammars used in BIND 9's ``named.conf`` configuration file. :ref:`troubleshooting` provides information on identifying and solving BIND 9 and DNS problems. Information about bug-reporting procedures is also provided. -:ref:`build_bind` is a definitive guide for those occasions where the user requires -special options not provided in the standard Linux or Unix distributions. +:ref:`build_bind` is a definitive guide for those occasions where the user requires +special options not provided in the standard Linux or Unix distributions. The **Appendices** contain useful reference information, such as a bibliography and historic information related to BIND and the Domain Name System, as well as the current *man* diff --git a/doc/arm/logging-categories.inc.rst b/doc/arm/logging-categories.inc.rst index 2bee205894..82160c78f0 100644 --- a/doc/arm/logging-categories.inc.rst +++ b/doc/arm/logging-categories.inc.rst @@ -35,9 +35,9 @@ ``edns-disabled`` Log queries that have been forced to use plain DNS due to timeouts. This is often due to the remote servers not being :rfc:`1034`-compliant (not always returning FORMERR or similar to EDNS queries and other extensions to the DNS when they are not understood). In other words, this is targeted at servers that fail to respond to DNS queries that they don't understand. - + Note: the log message can also be due to packet loss. Before reporting servers for non-:rfc:`1034` compliance they should be re-tested to determine the nature of the non-compliance. This testing should prevent or reduce the number of false-positive reports. - + Note: eventually :iscman:`named` will have to stop treating such timeouts as due to :rfc:`1034` non-compliance and start treating it as plain packet loss. Falsely classifying packet loss as due to :rfc:`1034` non-compliance impacts DNSSEC validation, which requires EDNS for the DNSSEC records to be returned. ``general`` @@ -57,16 +57,16 @@ ``queries`` A location where queries should be logged. - + At startup, specifying the category ``queries`` also enables query logging unless the :any:`querylog` option has been specified. - + The query log entry first reports a client object identifier in @0x format. Next, it reports the client's IP address and port number, and the query name, class, and type. Next, it reports whether the Recursion Desired flag was set (+ if set, - if not set), whether the query was signed (S), whether EDNS was in use along with the EDNS version number (E(#)), whether TCP was used (T), whether DO (DNSSEC Ok) was set (D), whether CD (Checking Disabled) was set (C), whether a valid DNS Server COOKIE was received (V), and whether a DNS COOKIE option without a valid Server COOKIE was present (K). After this, the destination address the query was sent to is reported. Finally, if any CLIENT-SUBNET option was present in the client query, it is included in square brackets in the format [ECS address/source/scope]. ``client 127.0.0.1#62536 (www.example.com):`` ``query: www.example.com IN AAAA +SE`` ``client ::1#62537 (www.example.net):`` ``query: www.example.net IN AAAA -SE`` - + The first part of this log message, showing the client address/port number and query name, is repeated in all subsequent log messages related to the same query. ``query-errors`` @@ -74,7 +74,7 @@ ``rate-limit`` Start, periodic, and final notices of the rate limiting of a stream of responses that are logged at ``info`` severity in this category. These messages include a hash value of the domain name of the response and the name itself, except when there is insufficient memory to record the name for the final notice. The final notice is normally delayed until about one minute after rate limiting stops. A lack of memory can hurry the final notice, which is indicated by an initial asterisk (\*). Various internal events are logged at debug level 1 and higher. - + Rate limiting of individual requests is logged in the ``query-errors`` category. ``resolver`` diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 7aea96ea13..162c6cc470 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -2576,7 +2576,7 @@ Boolean Options ``configure --disable-auto-validation``, in which case the default is ``yes``. - The default root trust anchor is compiled into :iscman:`named` + The default root trust anchor is compiled into :iscman:`named` and is current as of the release date. If the root key changes, a running BIND server will detect this and roll smoothly to the new key, but newly-installed servers will be unable to start validation, diff --git a/doc/arm/security.inc.rst b/doc/arm/security.inc.rst index 38b200a83e..2936432f3e 100644 --- a/doc/arm/security.inc.rst +++ b/doc/arm/security.inc.rst @@ -179,7 +179,7 @@ point of view, ``/var/named`` is the root of the filesystem; the values of options like :any:`directory` and :any:`pid-file` must be adjusted to account for this. -Unlike with earlier versions of BIND, +Unlike with earlier versions of BIND, :iscman:`named` does *not* typically need to be compiled statically, nor do shared libraries need to be installed under the new root. However, depending on the operating system, it may be necessary to set up locations such as ``/dev/zero``, ``/dev/random``, ``/dev/log``, and diff --git a/doc/arm/troubleshooting.inc.rst b/doc/arm/troubleshooting.inc.rst index a395357051..a2d81a9f1d 100644 --- a/doc/arm/troubleshooting.inc.rst +++ b/doc/arm/troubleshooting.inc.rst @@ -151,7 +151,7 @@ peer user support. In addition, ISC maintains a Knowledgebase of helpful article at https://kb.isc.org. Internet Systems Consortium (ISC) offers annual support agreements -for BIND 9, ISC DHCP, and Kea DHCP. +for BIND 9, ISC DHCP, and Kea DHCP. All paid support contracts include advance security notifications; some levels include service level agreements (SLAs), premium software features, and increased priority on bug fixes and feature requests. diff --git a/doc/design/cds-child b/doc/design/cds-child index 6234e26731..92ad6413d6 100644 --- a/doc/design/cds-child +++ b/doc/design/cds-child @@ -29,7 +29,7 @@ information regarding copyright ownership. Non-matching CDS and CDNSKEY are removed. -* auto-dnssec maintain should cds and/or cdnskey to zone apex iff the +* auto-dnssec maintain should cds and/or cdnskey to zone apex iff the DNSKEY is published and is signing the DNSKEY RRset. CDS and CDNSKEY records are only removed if there is a deletion date set (implicit on matching DNSKEY going inactive / unpublished or explicit). diff --git a/doc/design/dnssec-policy b/doc/design/dnssec-policy index a9b5b2ea92..e70114dfa8 100644 --- a/doc/design/dnssec-policy +++ b/doc/design/dnssec-policy @@ -89,7 +89,7 @@ is set for a zone. `dnssec-policy` statement will override the existing `max-zone-ttl` value. 1. `sig-signing-nodes`: This specifies the number of nodes to be examined - in a quantum when signing a zone with a new DNSKEY. This presumable is + in a quantum when signing a zone with a new DNSKEY. This presumable is to avoid keeping the database connection open for a long time. With the current database approach this probably needs to stay. diff --git a/doc/design/netmgr.md b/doc/design/netmgr.md index a5f34f3f29..171afbc090 100644 --- a/doc/design/netmgr.md +++ b/doc/design/netmgr.md @@ -44,7 +44,7 @@ the socket event, but this is still sub-optimal. The `isc_nm_t` structure represents the network manager itself. It contains a configurable number (generally the same as the number of CPUs) of 'networker' objects, each of which represents a thread for executing -networking events. +networking events. The manager contains flags to indicate whether it has been paused or interlocked, and counters for the number of workers running and the @@ -56,7 +56,7 @@ and a pool of buffers into which messages will be copied when received. ### `isc_nmsocket_t` `isc_nmsocket_t` is a wrapper around a libuv socket. It is configured -with +with ### `isc_nmhandle_t` diff --git a/doc/dev/dev.md b/doc/dev/dev.md index 1be096d6af..7c3d71c91a 100644 --- a/doc/dev/dev.md +++ b/doc/dev/dev.md @@ -427,7 +427,7 @@ into 'consumed' and 'remaining'. When parsing a message, the message to be parsed in in the 'used' part of the buffer. As the message is parsed, the 'consumed' -subregion grows and the 'remaining' subregion shrinks. +subregion grows and the 'remaining' subregion shrinks. When creating a message, data is written into the 'available' subregion, which then becomes part of 'used'. @@ -528,7 +528,7 @@ memory context is freed before all references have been cleaned up. /* Populate other isc_foo members here */ foo->magic = ISC_FOO_MAGIC; - + *foop = foo; return (ISC_R_SUCCESS); } @@ -813,7 +813,7 @@ The return value may be: * `dns_name_commonancestor`: name1 and name2 share some labels * `dns_name_equal`: name1 and name2 are the same -Some simpler comparison functions are provided for convenience when +Some simpler comparison functions are provided for convenience when not all of this information is required: * `dns_name_compare()`: returns the sort order of two names but @@ -884,7 +884,7 @@ sets have been defined: Each of these has a `first()`, `next()` and `current()` function; for example, `dns_rdataset_first()`, `dns_rdataset_next()`, and -`dns_rdataset_current()`. +`dns_rdataset_current()`. The `first()` and `next()` functions move the iterator's cursor and so that the data at a new location can be retrieved. (Most of these can only step @@ -1033,7 +1033,7 @@ messages up to the current debugging level are written to the channel. These objects -- the category, module, and channel -- direct hessages to desired destinations. Each category/module pair can be associated -with a specific channel, and the correct destination will be used +with a specific channel, and the correct destination will be used when a message is logged by `isc_log_write()`. In `isc_log_write()`, the logging system first looks up a list that @@ -1166,7 +1166,7 @@ to control the closing of log files. void isc_log_setdebuglevel(isc_log_t *lctx, unsigned int level); unsigned int isc_log_getdebuglevel(isc_log_t *lctx); - + These set and retrieve the current debugging level of the program. `isc_log_getdebuglevel()` can be used so that you need not keep track of the level yourself in another variable. diff --git a/doc/dnssec-guide/introduction.rst b/doc/dnssec-guide/introduction.rst index f4ec793dd0..aadc4e049b 100644 --- a/doc/dnssec-guide/introduction.rst +++ b/doc/dnssec-guide/introduction.rst @@ -41,7 +41,7 @@ Who May Not Want to Read this Guide? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you are already operating a DNSSEC-signed zone, you may not learn -much from the first half of this document, and you may want to start with +much from the first half of this document, and you may want to start with :ref:`dnssec_advanced_discussions`. If you want to learn about details of the protocol extension, such as data fields and flags, or the new record types, this document can help you get started but it @@ -221,7 +221,7 @@ trust one key: the root key. The 12-Step DNSSEC Validation Process (Simplified) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The following example shows the 12 steps of the DNSSEC validating process +The following example shows the 12 steps of the DNSSEC validating process at a very high level, looking up the name ``www.isc.org`` : .. figure:: ../dnssec-guide/img/dnssec-12-steps.png diff --git a/doc/dnssec-guide/preface.rst b/doc/dnssec-guide/preface.rst index 13ba820cb1..fb6bd67d68 100644 --- a/doc/dnssec-guide/preface.rst +++ b/doc/dnssec-guide/preface.rst @@ -35,7 +35,7 @@ some examples of tools to verify that the resolver is properly validating answers. :ref:`dnssec_signing` explains how to set up a basic signed -authoritative zone, details the relationship between a child and a parent zone, +authoritative zone, details the relationship between a child and a parent zone, and discusses ongoing maintenance tasks. :ref:`dnssec_troubleshooting` provides some tips on how to analyze diff --git a/doc/dnssec-guide/recipes.rst b/doc/dnssec-guide/recipes.rst index 56eb1a514b..42ee7820fc 100644 --- a/doc/dnssec-guide/recipes.rst +++ b/doc/dnssec-guide/recipes.rst @@ -229,7 +229,7 @@ generate a successor key (51623): ./Kexample.com.+008+17694.private # dnssec-keygen -S Kexample.com.+008+17694 - Generating key pair..++++++ ...........++++++ + Generating key pair..++++++ ...........++++++ Kexample.com.+008+51623 The first command gets us into the key directory @@ -261,7 +261,7 @@ file: :: # cd /etc/bind/keys/example.com - # cat Kexample.com.+008+51623.key + # cat Kexample.com.+008+51623.key ; This is a zone-signing key, keyid 11623, for example.com. ; Created: 20201130160024 (Mon Dec 1 00:00:24 2020) ; Publish: 20201202000000 (Fri Dec 2 08:00:00 2020) @@ -480,7 +480,7 @@ DS record based on the new key, 23550: ./Kexample.com.+007+24848.key ./Kexample.com.+007+24848.private # dnssec-keygen -S Kexample.com.+007+24848 - Generating key pair.......................................................................................++ ...................................++ + Generating key pair.......................................................................................++ ...................................++ Kexample.com.+007+23550 # dnssec-dsfromkey -a SHA-1 Kexample.com.+007+23550.key example.com. IN DS 23550 7 1 54FCF030AA1C79C0088FDEC1BD1C37DAA2E70DFB diff --git a/doc/dnssec-guide/signing.rst b/doc/dnssec-guide/signing.rst index 2d5045b27d..3fe1d046e6 100644 --- a/doc/dnssec-guide/signing.rst +++ b/doc/dnssec-guide/signing.rst @@ -440,7 +440,7 @@ key, and we expect to see it returned when we query for it. 6saiq99qDBb5b4G4cx13cPjFTrIvUs3NW44SvbbHorHb kXwOzeGAWyPORN+pwEV/LP9+FHAF/JzAJYdqp+o0dw== ) ; KSK; alg = ECDSAP256SHA256 ; key id = 10376 - + .. _signing_verify_signature: @@ -1106,7 +1106,7 @@ record) to the parent zone to complete the chain of trust. in this document. We trust you, a responsible DNS administrator, to take the necessary precautions to secure your system. - + For our examples below, we work with the assumption that there is an existing insecure zone ``example.com`` that we are converting to a secure version. The secure version uses both a KSK diff --git a/doc/dnssec-guide/troubleshooting.rst b/doc/dnssec-guide/troubleshooting.rst index 551800294d..ca8e4f52a0 100644 --- a/doc/dnssec-guide/troubleshooting.rst +++ b/doc/dnssec-guide/troubleshooting.rst @@ -139,7 +139,7 @@ With :iscman:`delv`, a "resolution failed" message is output instead: $ delv @10.53.0.3 www.example.org. A +rtrace ;; fetch: www.example.org/A ;; resolution failed: SERVFAIL - + BIND 9 logging features may be useful when trying to identify DNSSEC errors. @@ -545,7 +545,7 @@ NTAs are added using the :iscman:`rndc` command, e.g.: $ rndc nta example.com Negative trust anchor added: example.com/_default, expires 19-Mar-2020 19:57:42.000 - + The list of currently configured NTAs can also be examined using :iscman:`rndc`, e.g.: @@ -554,7 +554,7 @@ The list of currently configured NTAs can also be examined using $ rndc nta -dump example.com/_default: expiry 19-Mar-2020 19:57:42.000 - + The default lifetime of an NTA is one hour, although by default, BIND polls the zone every five minutes to see if the zone correctly diff --git a/doc/doxygen/Doxyfile.in b/doc/doxygen/Doxyfile.in index 3dd23e78f8..a916d7b795 100644 --- a/doc/doxygen/Doxyfile.in +++ b/doc/doxygen/Doxyfile.in @@ -25,207 +25,207 @@ # Project related configuration options #--------------------------------------------------------------------------- -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = "BIND9 Internals" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = $(BIND9_VERSION) -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, # Swedish, and Ukrainian. OUTPUT_LANGUAGE = English -# This tag can be used to specify the encoding used in the generated output. -# The encoding is not always determined by the language that is chosen, -# but also whether or not the output is meant for Windows or non-Windows users. -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES -# forces the Windows encoding (this is the default for the Windows binary), -# whereas setting the tag to NO uses a Unix-style encoding (the default for +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for # all platforms other than Windows). USE_WINDOWS_ENCODING = NO -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = @BIND9_TOP_BUILDDIR@/ -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an # explicit @brief command for a brief description. JAVADOC_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member +# If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes # will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to +# include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = YES -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES @@ -234,240 +234,240 @@ SUBGROUPING = YES # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = YES -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = NO -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. SHOW_DIRECTORIES = YES -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from the +# version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = YES -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = @BIND9_TOP_BUILDDIR@/lib/isc \ @@ -483,88 +483,88 @@ INPUT = @BIND9_TOP_BUILDDIR@/lib/isc \ @BIND9_TOP_BUILDDIR@/bin/rndc \ @BIND9_TOP_BUILDDIR@/doc/doxygen/mainpage -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py FILE_PATTERNS = *.c *.h *.dox -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = */lib/dns/gen* */lib/dns/rdata/*.h -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = * -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = ./doxygen-input-filter -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO @@ -573,32 +573,32 @@ FILTER_SOURCE_FILES = NO # configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = YES -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = NO -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES @@ -610,16 +610,16 @@ REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES @@ -628,133 +628,133 @@ VERBATIM_HEADERS = YES # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = isc-header.html -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = isc-footer.html -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = +HTML_STYLESHEET = -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [1..20]) +# This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. GENERATE_TREEVIEW = NO -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 @@ -763,74 +763,74 @@ TREEVIEW_WIDTH = 250 # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = YES -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = letter -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! -LATEX_HEADER = +LATEX_HEADER = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = NO -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = YES -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = YES @@ -839,68 +839,68 @@ LATEX_HIDE_INDICES = YES # configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO @@ -909,33 +909,33 @@ MAN_LINKS = NO # configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = YES -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_SCHEMA = +XML_SCHEMA = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_DTD = +XML_DTD = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES @@ -944,10 +944,10 @@ XML_PROGRAMLISTING = YES # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO @@ -956,320 +956,320 @@ GENERATE_AUTOGEN_DEF = NO # configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = YES -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = YES -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = +INCLUDE_PATH = -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = "ISC_FORMAT_PRINTF(fmt, args)=" \ "LIBRPZ_PF(f, l)=" -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen +# If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = @PERL@ #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = NO -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected # functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a caller dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected # functions only using the \callergraph command. CALLER_GRAPH = YES -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. -DOT_PATH = +DOT_PATH = -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the # \dotfile command). -DOTFILE_DIRS = +DOTFILE_DIRS = -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_WIDTH = 1024 -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_HEIGHT = 1024 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that a graph may be further truncated if the graph's -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that a graph may be further truncated if the graph's +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), # the graph is not depth-constrained. MAX_DOT_GRAPH_DEPTH = 1000 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to # read). DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- -# The SEARCHENGINE tag specifies whether or not a search engine should be +# The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO diff --git a/util/check-pullups.pl b/util/check-pullups.pl index 982adbd1a5..2c8d881ef6 100644 --- a/util/check-pullups.pl +++ b/util/check-pullups.pl @@ -26,7 +26,7 @@ sub readfile { my ($fn) = @_; my $fh = new FileHandle($fn, "r") or die "open: $fn: $!"; - + my $changes = { }; my ($changeid, $category);