Documentation updates

Remove placeholder for the docs inside the logs middleware and
explain response codes better.
This commit is contained in:
Miek Gieben 2016-04-04 15:45:11 +00:00
parent 20c81f54a4
commit 4c55b6732f
2 changed files with 9 additions and 33 deletions

View file

@ -18,9 +18,15 @@ type (
// and/or error.
//
// If ServeDNS writes to the response body, it should return a status
// code of 0. This signals to other handlers above it that the response
// body is already written, and that they should not write to it also.
// TODO(miek): explain return codes better.
// code. If the status code is not one of the following:
// * SERVFAIL (dns.RcodeServerFailure)
// * REFUSED (dns.RecodeRefused)
// * FORMERR (dns.RcodeFormatError)
// * NOTIMP (dns.RcodeNotImplemented)
//
// CoreDNS assumes *no* reply has yet been written. All other response
// codes signal other handlers above it that the response message is
// already written, and that they should not write to it also.
//
// If ServeDNS encounters an error, it should return the error value
// so it can be logged by designated error-handling middleware.