From: Ondřej Surý <ondrej@sury.org>
Date: Thu, 7 Oct 2021 06:05:16 +0000 (+0200)
Subject: Update isc_result_t developer documentation
X-Git-Tag: v9.17.19~6^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=848fef4d4db3be153355e08d8411e50740c1bf30;p=thirdparty%2Fbind9.git

Update isc_result_t developer documentation

There's no multiple result.{c,h} location to defining result codes,
update the documentation accordingly.
---

diff --git a/doc/dev/dev.md b/doc/dev/dev.md
index 9a765090c21..c68f445ede1 100644
--- a/doc/dev/dev.md
+++ b/doc/dev/dev.md
@@ -392,12 +392,11 @@ A result code can be converted to a human-readable error message by
 calling `isc_result_totext(result)`.
 
 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
-for the ISC library are in `lib/isc/include/isc/result.h`.
+in `lib/isc/include/isc/result.h`.
 
 ISC library result codes (many of which are generically useful elsewhere)
 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`,
 etc).  Other sets of result codes are defined for crypto functions (`DST_R`