Commit Graph
6297 Commits
Author SHA1 Message Date
Petr Špaček d16197fe62 Remove obsolete RFCs from documentation
There is little point of listing all of the obsolete RFCs. I think it is
more likely confuse people than to do anything useful.

(cherry picked from commit 9437ea08e1)
2022-02-14 12:20:14 +01:00
Petr Špaček 8925fb2e56 Replace obsolete RFC6488 reference with RFC8659 (CAA)
(cherry picked from commit 2b5b777c07)
2022-02-14 12:20:11 +01:00
Petr Špaček d1ee57b4bd Remove obsolete book reference from ARM
(cherry picked from commit b686b5c161)
2022-02-14 12:19:29 +01:00
Petr Špaček d7ca8c4c9b Use Sphinx footnotes for DNS Reference Information
It limits risk of errors while doing updates, which are next in the
pipeline.

(cherry picked from commit f713984886)
2022-02-14 12:19:24 +01:00
Ondřej Surý 2889492865 Add CHANGES and release note for [GL #3137]
(cherry picked from commit 44aa8ef997)
2022-02-10 21:28:48 +01:00
Evan Hunt 556f4d8870 Release notes for [GL #3082] and [GL #3111]
(cherry picked from commit d45f0e1d9e)
2022-02-02 12:04:48 -08:00
Ondřej SurýandPetr Špaček 774d82bde1 Clarify effect of "directory" configuration option
The "directory" configuration options affects the configuration listed
after the directive but not before which may affect ``include``
directive with relative file paths.

(cherry picked from commit 00ba6967b1)
2022-02-02 12:34:08 +01:00
Ondřej Surý 4f6f74015f Add CHANGES and release notes for [GL #3125]
(cherry picked from commit 932fc7b826703f8b0f30ed11c496f94a02e6ebbb)
2022-02-01 21:16:27 +01:00
Petr Špaček 3819f88c66 Rename parental-agents grammar file
For consistency with rest of the system, the grammar file and
the link anchors were renamed from "parentals" to "parental-agents".

Technically this is fixup for commit
90ef2b9c81.

Related: !5239
(reimplementation of commit 34a3b35b08)
2022-02-01 18:59:41 +01:00
Petr Špaček 2fd265eebe Regenerate .rst files with grammars after changes to rst generators
$ make -C doc/misc rst

(reimplementation of commit e97c35b3bc)
2022-02-01 18:59:31 +01:00
Mark AndrewsandPetr Špaček f6aa69889f Fix grammar generators to produce renderable include files in rst format
The missing `::` in the .rst files caused grammar section in docs to
render empty.

The `::` was accidentally removed in an unrelated commit
58bd26b6cf which was supposed to update
only copyright headers.

Fixes: #3120
(cherry picked from commit d975e6630f)
2022-02-01 18:29:23 +01:00
Mark AndrewsandPetr Špaček 8acbf77da0 Add missing rst-grammars.pl dependecy to config grammar build
(reimplementation of commit f5c66f311a)
2022-02-01 18:29:03 +01:00
Ondřej Surý 4b93ec0805 Fix typo in qname-wait-recurse
In the RPZ documentation, there's a mistake where it states that the
default behavior will be disabled by setting `qname-wait-recurse yes;`
while in fact it's opposite `qname-wait-recurse no;`.

This affects only the RST documentation.

(cherry picked from commit 1e711dcccb)
2022-01-27 12:55:47 +01:00
Petr Špaček 57f5a2f6e0 Fix incorrect RFC footnote about A6 RR type in RFC4033
A6 type is not mentioned anywhere in RFC4033.

(cherry-picked from commit ee3ba3cac9)
2022-01-26 12:03:35 +01:00
Petr Špaček c843c73e42 Remove RFCs not implemented in BIND from list in the ARM
This commit partially removes extra RFCs which are not listed in
file doc/misc/rfc-compliance.

Most of the removed RFCs are either outright obsolete, irrelevant,
or not implemented. Rationale:
- 974 - obsolete
- 1033 - ops info, hardly followed today
- 1464 - ops info
- 1591 - policy
- 1537 - obsolete
- 1713 - obsolete
- 1794 - notimp
- 2010 - ops info
- 2052 - obsolete
- 2065 - obsolete
- 2137 - obsolete
- 2168 - obsolete
- 2240 - obsolete
- 2345 - not dns
- 2352 - not dns
- 2540 - notimp
- 2825 - notimp, info, obsolete
- 2826 - notimp
- 2929 - obsolete
- 3071 - policy
- 3090 - obsolete
- 3258 - notimp
- 6594 - iana, SSHFP
- 7216 - not dns
- 8482 - notimp
- 8490 - notimp

Probably most notable RFCs removed are:
- 8482 for special ANY handling
- 8490 for Stateful Operations
As far as I can tell BIND does not implement those.

(cherry-picked from commit 8c82b0f2d0)
2022-01-26 12:03:35 +01:00
Petr Špaček e538995890 Reword RFC section in the ARM
Add couple links and caveant for uninitiated readers.

(cherry-picked from commit 4379e16996)
2022-01-26 12:03:35 +01:00
Petr Špaček b73623370e Add RFCs listed in doc/misc/rfc-compliance to doc/arm/general.rst
There were three RFCs listed in list of "RFCs we implement" but missing
in the ARM.

Command to compare lists in the two documents:

    diff <(grep -o '^  RFC[0-9]\+' doc/misc/rfc-compliance | sed -e 's/[^0-9]//g' | sort -n) <(grep  '^:rfc:`' doc/arm/general.rst | sed -e 's/^.*`\([0-9]*\)`.*$/\1/' | sort -n)

(cherry-picked from commit b1af79acc7)
2022-01-26 12:03:35 +01:00
Petr Špaček fc77d0e4bf Rework doc/arm/build.rst
- Revise the list of required libraries.
  - Apply miscellaneous tweaks to style, formatting, and ordering.

(cherry-picked from commit 4b1c70de90)
2022-01-26 12:03:35 +01:00
Petr Špaček 2542fdf059 Deduplicate text between Building BIND 9 / Supported Platforms in the ARM
Supported Platforms section is now really only about platforms and not
libraries. Libraries were moved to the Building BIND section.

We now have section for required libraries, and second with optional
features.  Wordy explanations were taken verbatim from the original
README.md.

(cherry-picked from commit 2c81fa9013)
2022-01-26 12:03:35 +01:00
Petr Špaček d351f78709 Convert "Building BIND" section from README.md to reStructuredText
Converted using pandoc 2.14.2-14 on Arch Linux:

    $ pandoc --shift-heading-level-by=-1 -f markdown -t rst README.md > doc/arm/build.rst

Plus hand-edit to remove sections other than Building BIND 9, remove
misindentation in section headers, and add a standard copyright header.
2022-01-26 12:03:35 +01:00
Petr Špaček 5058817f5a Link to ISC KB for most up-to-date platform support statuses
(cherry-picked from commit 3bd4318fcc)
2022-01-26 12:03:35 +01:00
Petr Špaček 27cfa574dc Replace all occurences of PLATFORMS file with reference to the ARM
The conf.py exclude_patterns now includes platforms.rst to avoid
problems with redefining labels:
https://github.com/sphinx-doc/sphinx/issues/1668#issuecomment-71376208

Plain-text README file was regenerated using commands from v9.16
Makefile.

(cherry-picked from commit 920a2e730b)
2022-01-26 12:03:35 +01:00
Petr Špaček dd901b5c42 Replace duplicate Supported Operating Systems in the ARM by PLATFORMS.rst
(cherry-picked from commit f693c9b1a7)
2022-01-26 12:03:35 +01:00
Aram Sargsyan acc774e4dd Add CHANGES and release notes for [GL #3060]
(cherry picked from commit d7dfa2dc4b)
2022-01-26 08:19:02 +00:00
Petr Špaček 675f6c6b57 Remove reference to (unavailable) nsdname-wait-recurse option from ARM
This option is available only in 9.16-S edition, but docs for it were
accidentally imported when documentation was migrated to Sphinx in
!3536.
2022-01-24 17:34:53 +01:00
Petr Špaček ea4a90a96a Fix inconsistent release note for #1807
This was an omission in !3495.
2022-01-24 17:34:53 +01:00
Petr Špaček c3a1287e1f Add missing release notes for CVE-2020-8616 and CVE-2020-8617
These release notes were lost when converting docs from XML to RST
formats. These two notes were removed by commit
5a855f6754.

Related: #1388, #1703, !3536
2022-01-24 17:34:48 +01:00
Petr Špaček da70d59f40 Remove duplicate named.conf.rst file
As far as I can tell, it is some leftover from the times when Sphinx
docs were introduced (commit 9fb6d11abb).
It seems like it is not referenced from anywhere.

(cherry picked from commit 0a5c2c23bb)
2022-01-21 15:33:40 +01:00
Michał Kępień 5111a76eb0 Prepare release notes for BIND 9.16.26 2022-01-20 11:38:18 +01:00
Michał Kępień 9987ff1edf Prepare release notes for BIND 9.16.25 2022-01-20 11:37:08 +01:00
Michał Kępień c5f7ece3ad Reorder release notes 2022-01-20 11:37:08 +01:00
Petr ŠpačekandMichał Kępień 00aeba54c9 Tweak and reword release notes 2022-01-20 11:37:08 +01:00
Dan TheisenandOndřej Surý 133b5c1a52 docs: Update ARM to reflect changes to acceptable cookie-secret values
(cherry picked from commit acf1d502d6)
2022-01-17 11:52:13 +01:00
Ondřej Surý 35aba6f078 Add missing backtick to host.rst
The missing backtick was causing formatting problems in the host
manpage.

(cherry picked from commit aaa31962d2)
2022-01-16 08:02:26 +01:00
Ondřej Surý 4666cb4a4e Add CHANGES and release notes for [GL #3095]
(cherry picked from commit 8d778f758b)
2022-01-13 23:05:38 +01:00
Ondřej Surý 2bf7921c7e Update the copyright information in all files in the repository
This commit converts the license handling to adhere to the REUSE
specification.  It specifically:

1. Adds used licnses to LICENSES/ directory

2. Add "isc" template for adding the copyright boilerplate

3. Changes all source files to include copyright and SPDX license
   header, this includes all the C sources, documentation, zone files,
   configuration files.  There are notes in the doc/dev/copyrights file
   on how to add correct headers to the new files.

4. Handle the rest that can't be modified via .reuse/dep5 file.  The
   binary (or otherwise unmodifiable) files could have license places
   next to them in <foo>.license file, but this would lead to cluttered
   repository and most of the files handled in the .reuse/dep5 file are
   system test files.

(cherry picked from commit 58bd26b6cf)
2022-01-11 12:22:09 +01:00
Björn PerssonandMark Andrews fd1d6b5d1c Document the interation of DNS COOKIE and RRL
Send back BADCOOKIE responses instead of TC=1 when slipping.

Skip rate limiting for UDP requests with valid server cookies.

(cherry picked from commit a59482b85c)
2022-01-07 19:29:26 +11:00
Ondřej Surý 21b74b8c48 Add CHANGES and release note for [GL #3079]
(cherry picked from commit 5563d06d62)
2022-01-06 20:00:44 +01:00
Vicky RiskandPetr Špaček 18322cd85b Update preface.rst of DNSSEC Guide with new contact info for Josh Kuo
(cherry picked from commit 896fa924f3)
2022-01-06 16:20:11 +01:00
Ondřej SurýandOndřej Surý 721c175bf4 Add CHANGES and release note for [GL #3071]
(cherry picked from commit ff8d37cbdb)
2022-01-06 12:27:12 +01:00
Ondřej Surý 4aed6821d7 Revert "Add CHANGES and release note for [GL #3071]"
This reverts commit 7a6365d02875ca1344013ad16ae2d33a51307bec.

(cherry picked from commit 5f36948176)
2022-01-06 12:27:12 +01:00
Matthijs Mekking b002ed569c Add CHANGES and release note for GL #3049
This is a bugfix worth mentioning.

(cherry picked from commit f3e668d630)
2022-01-06 09:35:48 +01:00
Matthijs Mekking 219f5ebd32 Update auto-dnssec documentation
Explain that 'auto-dnssec' may only be activated at zone level.

(cherry picked from commit aac39647f3)
2022-01-05 11:57:08 +01:00
Ondřej SurýandOndřej Surý 604612e5b9 Add CHANGES and release note for [GL #3071]
(cherry picked from commit 4d71a3b309)
2022-01-05 10:33:46 +01:00
Michal Nowak 71d780df3c Update copyrights to 2022
(cherry picked from commit befd654e00)
2022-01-03 11:57:58 +01:00
Michał Kępień 523b38875e Remove man_SPHINXOPTS from doc/arm/Makefile.in
The man_SPHINXOPTS variable is only used in doc/man/Makefile.in.  Remove
its duplicate definition from doc/arm/Makefile.in.
2021-12-29 09:59:38 +01:00
Michał Kępień 7eac78ccc0 Clarify use of the "today" Sphinx variable
Add a comment explaining the purpose of setting the "today" variable in
Sphinx invocations to prevent confusion caused by the absence of that
variable from reStructuredText sources.

(cherry picked from commit e67cdb390a)
2021-12-29 09:59:38 +01:00
Michał Kępień 02387700ff Set version and release variables in conf.py
Some Sphinx variables used in the ARM are only set in
doc/arm/Makefile.in.  This works fine when building the ARM using
"make", but does not work with Read the Docs, which only looks at
conf.py files.

Since Read the Docs does not run ./configure, renaming conf.py to
conf.py.in and using Autoconf output variables is not a feasible
solution.

Instead, extend doc/arm/conf.py with some Python code which processes
the "version" file using regular expressions and sets the relevant
Sphinx variables accordingly.  As this solution also works fine when
building the ARM using "make", drop the relevant -D options from the
list of sphinx-build options used for building the ARM in
doc/arm/Makefile.in.

Note that the man_SPHINXOPTS counterparts of the removed -D switches are
left intact because doc/man/conf.py is a separate Sphinx project which
is only processed using "make" and duplicating the Python code added to
doc/arm/conf.py by this commit would be inelegant.

(cherry picked from commit 38d251e11b)
2021-12-29 09:59:38 +01:00
Petr Špaček d9d6c0ba66 Set up release notes for BIND 9.16.25 2021-12-16 13:29:31 +01:00
Michał KępieńandPetr Špaček 7a88254d2c Prepare release notes for BIND 9.16.24 2021-12-16 13:29:04 +01:00