2
0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-22 10:10:06 +00:00

Update isc_result_t developer documentation

There's no multiple result.{c,h} location to defining result codes,
update the documentation accordingly.
This commit is contained in:
Ondřej Surý 2021-10-07 08:05:16 +02:00
parent 3b9d9f5afb
commit 848fef4d4d

View File

@ -392,12 +392,11 @@ A result code can be converted to a human-readable error message by
calling `isc_result_totext(result)`. calling `isc_result_totext(result)`.
Many result codes have been defined and can be found in the source tree Many result codes have been defined and can be found in the source tree
in header files called `result.h` (for example, the result codes defined in `lib/isc/include/isc/result.h`.
for the ISC library are in `lib/isc/include/isc/result.h`.
ISC library result codes (many of which are generically useful elsewhere) ISC library result codes (many of which are generically useful elsewhere)
begin with `ISC_R`: examples include `ISC_R_SUCCESS`, `ISC_R_FAILURE`, begin with `ISC_R`: examples include `ISC_R_SUCCESS`, `ISC_R_FAILURE`,
`ISC_R_NOMEMORY`, etc. `ISC_R_NOMEMORY`, etc.
DNS library result codes begin with `DNS_R`: `DNS_R_SERVFAIL`, `DNS_R_NXRRSET`, DNS library result codes begin with `DNS_R`: `DNS_R_SERVFAIL`, `DNS_R_NXRRSET`,
etc). Other sets of result codes are defined for crypto functions (`DST_R` etc). Other sets of result codes are defined for crypto functions (`DST_R`