tweaks to the documentation

This commit is contained in:
Miek Gieben 2012-08-24 09:35:33 +02:00
parent 2d90a06ade
commit b96e6ac78d
4 changed files with 6 additions and 6 deletions

6
dns.go
View File

@ -12,7 +12,7 @@
// //
// The package dns supports (async) querying/replying, incoming/outgoing Axfr/Ixfr, // The package dns supports (async) querying/replying, incoming/outgoing Axfr/Ixfr,
// TSIG, EDNS0, dynamic updates, notifies and DNSSEC validation/signing. // TSIG, EDNS0, dynamic updates, notifies and DNSSEC validation/signing.
// Note that domain names MUST be full qualified, before sending them. // Note that domain names MUST be fully qualified, before sending them.
// //
// Resource records are native types. They are not stored in wire format. // Resource records are native types. They are not stored in wire format.
// Basic usage pattern for creating a new resource record: // Basic usage pattern for creating a new resource record:
@ -48,7 +48,7 @@
// //
// m1 := new(dns.Msg) // m1 := new(dns.Msg)
// m1.MsgHdr.Id = Id() // m1.MsgHdr.Id = Id()
// m1.MsgHdr.RecursionDesired = false // m1.MsgHdr.RecursionDesired = true
// m1.Question = make([]Question, 1) // m1.Question = make([]Question, 1)
// m1.Question[0] = dns.Question{"miek.nl.", dns.TypeMX, dns.ClassINET} // m1.Question[0] = dns.Question{"miek.nl.", dns.TypeMX, dns.ClassINET}
// //
@ -62,7 +62,7 @@
// An asynchronous query is also possible, see client.Do and client.DoRtt. // An asynchronous query is also possible, see client.Do and client.DoRtt.
// //
// From a birds eye view a dns message consists out of four sections. // From a birds eye view a dns message consists out of four sections.
// The question section: in.Question, the answer answer section: in.Answer, // The question section: in.Question, the answer section: in.Answer,
// the authority section: in.Ns and the additional section: in.Extra. // the authority section: in.Ns and the additional section: in.Extra.
// //
// Each of these sections (except the Question section) contain a []RR. Basic // Each of these sections (except the Question section) contain a []RR. Basic

View File

@ -306,7 +306,7 @@ func (s *RR_RRSIG) Sign(k PrivateKey, rrset []RR) error {
// Verify validates an RRSet with the signature and key. This is only the // Verify validates an RRSet with the signature and key. This is only the
// cryptographic test, the signature validity period must be checked separately. // cryptographic test, the signature validity period must be checked separately.
// This function copies the rdata of some RRs (to lowercases domain names) for the validation to work. // This function copies the rdata of some RRs (to lowercase domain names) for the validation to work.
func (s *RR_RRSIG) Verify(k *RR_DNSKEY, rrset []RR) error { func (s *RR_RRSIG) Verify(k *RR_DNSKEY, rrset []RR) error {
// First the easy checks // First the easy checks
if len(rrset) == 0 { if len(rrset) == 0 {

View File

@ -72,7 +72,6 @@ const (
HmacSHA256 = "hmac-sha256." HmacSHA256 = "hmac-sha256."
) )
// RFC 2845.
type RR_TSIG struct { type RR_TSIG struct {
Hdr RR_Header Hdr RR_Header
Algorithm string `dns:"domain-name"` Algorithm string `dns:"domain-name"`

View File

@ -51,7 +51,8 @@ func NewZone(origin string) *Zone {
return z return z
} }
// Insert inserts an RR into the zone. Duplicate data overwrites the old data. // Insert inserts an RR into the zone. Duplicate data overwrites the old data without
// warning.
func (z *Zone) Insert(r RR) error { func (z *Zone) Insert(r RR) error {
if !IsSubDomain(z.Origin, r.Header().Name) { if !IsSubDomain(z.Origin, r.Header().Name) {
return &Error{Err: "out of zone data", Name: r.Header().Name} return &Error{Err: "out of zone data", Name: r.Header().Name}