]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Small developer documentation cleanups
authorTony Finch <fanf@isc.org>
Wed, 9 Mar 2022 14:32:48 +0000 (14:32 +0000)
committerTony Finch <fanf@isc.org>
Wed, 9 Mar 2022 18:01:28 +0000 (18:01 +0000)
GitLab replaced RT, we don't support 1990s operating systems, we
like wrapped paragraphs, and we don't need that extra comma.

doc/dev/dev.md
doc/dev/style.md

index 1435423f4fd02f412aaffa4a371c9523f6216a92..7150bcf79fbc41769bfd4d201fce6bd722d3e42b 100644 (file)
@@ -47,7 +47,7 @@ particular, a full regression test (`make` `check`) must be run for every
 modification so that unexpected side-effects are identified.
 
 When a problem or concern is found by the reviewer, these comments are
-placed on the RT ticket so the author can respond.
+placed on the merge request in GitLab so the author can respond.
 
 #### What is reviewed:
 
@@ -204,7 +204,7 @@ points to `rndc`, `SIGNZONE` to `dnssec-signzone`, etc.
 
 #### <a name="unittest"></a> Building unit tests
 
-BIND uses the cmocka, unit testing framework.
+BIND uses the cmocka unit testing framework.
 
 To build BIND with unit tests, run `configure` with the `--with-cmocka`
 option.  This requires cmocka >= 1.0.0 to be installed in the system.
index 11d2535f600a888d90e53b0726d5baa49c0325ac..72a8ef15a5e4c9cce9d5af876715dc0e9ea9dc05 100644 (file)
@@ -795,8 +795,7 @@ Source which becomes obsolete should be removed, not just disabled with
 
 When using a C library function, consider whether all operating systems
 support it.  Is it in the POSIX standard?  If so, how long has it been
-there? (BIND is still run on some operating systems released in the
-1990s.)  Is its behavior the same on all platforms?  Is its signature
+there?  Is its behavior the same on all platforms?  Is its signature
 the same?  Are integer parameters the same size and signedness?  Does it
 always return the same values on success, and set the same `errno` codes
 on failure?
@@ -849,9 +848,15 @@ program's inputs or operation.
 
 ### <a name="pystyle"></a>Python
 
-BIND 9 contains some optional tools written in Python, in the `bin/python` subdirectory.  Python scripts are stored in the git repository as `{toolname}.py.in`; and `{toolname}.py` will be generated by `configure` (which determines, among other things, the path to the Python interpreter).
+BIND 9 contains some optional tools written in Python, in the
+`bin/python` subdirectory. Python scripts are stored in the git
+repository as `{toolname}.py.in`; and `{toolname}.py` will be
+generated by `configure` (which determines, among other things, the
+path to the Python interpreter).
 
-For Python coding, we abide by the Python style guidelines described [here](http://www.python.org/dev/peps/pep-0008/), with a few modifications:
+For Python coding, we abide by the Python style guidelines described
+in [PEP8](http://www.python.org/dev/peps/pep-0008/), with a few
+modifications:
 
 * The `__init__()` method should always be the first one declared in a
   class definition, like so: