mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-09-01 15:05:23 +00:00
Code Issues Releases Wiki Activity

Small developer documentation cleanups

Browse Source 
GitLab replaced RT, we don't support 1990s operating systems, we
like wrapped paragraphs, and we don't need that extra comma.
This commit is contained in:
Tony Finch
2022-03-09 14:32:48 +00:00
parent ec1e8e7001
commit 328d11297d
2 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/dev/dev.md
View 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. modification so that unexpected side-effects are identified.
When a problem or concern is found by the reviewer, these comments are 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: #### What is reviewed:
@@ -204,7 +204,7 @@ points to `rndc`, `SIGNZONE` to `dnssec-signzone`, etc.
#### <a name="unittest"></a> Building unit tests #### <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` 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. option. This requires cmocka >= 1.0.0 to be installed in the system.

13
doc/dev/style.md
View 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 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 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 there? Is its behavior the same on all platforms? Is its signature
1990s.) Is its behavior the same on all platforms? Is its signature
the same? Are integer parameters the same size and signedness? Does it 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 always return the same values on success, and set the same `errno` codes
on failure? on failure?
@@ -849,9 +848,15 @@ program's inputs or operation.
### <a name="pystyle"></a>Python ### <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 * The `__init__()` method should always be the first one declared in a
class definition, like so: class definition, like so: