From ffe42637c54d2bb2ec926e9b4f70041e60241d94 Mon Sep 17 00:00:00 2001 From: Miek Gieben Date: Sat, 1 Dec 2012 12:44:57 +0100 Subject: [PATCH 1/2] Documentation --- dnssec.go | 4 ++-- edns.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/dnssec.go b/dnssec.go index 4987b956..f6bf75c9 100644 --- a/dnssec.go +++ b/dnssec.go @@ -3,7 +3,7 @@ // DNSSEC // // DNSSEC (DNS Security Extension) adds a layer of security to the DNS. It -// uses public key cryptography to securely sign resource records. The +// uses public key cryptography to sign resource records. The // public keys are stored in DNSKEY records and the signatures in RRSIG records. // // Requesting DNSSEC information for a zone is done by adding the DO (DNSSEC OK) bit @@ -14,7 +14,7 @@ // // Signature generation, signature verification and key generation are all supported. // Writing a DNSSEC validating resolver is hard, if you need something like that you -// might want to use the unbound wrapper found at github.com/miekg/unbound . +// might want to use the Unbound wrapper found at github.com/miekg/unbound . package dns import ( diff --git a/edns.go b/edns.go index 76a9041a..8b48c762 100644 --- a/edns.go +++ b/edns.go @@ -5,7 +5,7 @@ // Basic use pattern for creating an (empty) OPT RR: // // o := new(dns.RR_OPT) -// o.Hdr.Name = "." +// o.Hdr.Name = "." // MUST be the root zone, per definition. // o.Hdr.Rrtype = dns.TypeOPT // // The rdata of an OPT RR consists out of a slice of EDNS0 interfaces. Currently From f6d5ab4e2ef76713fe9bfbd2274d73e8e652416c Mon Sep 17 00:00:00 2001 From: Miek Gieben Date: Sat, 1 Dec 2012 21:29:47 +0100 Subject: [PATCH 2/2] Add comments from Stephan --- README.markdown | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.markdown b/README.markdown index 22cce1e1..0cc7e81e 100644 --- a/README.markdown +++ b/README.markdown @@ -46,9 +46,11 @@ correctly the following should work: go get github.com/miekg/dns go build dns -Sample programs can be found in the `ex` directory. They can -also be build with: `go build`. - +A short "how to use the API" is at the beginning of dns.go (this also will show +when you call `go doc github.com/miekg/dns`. Sample +programs can be found in the `ex` directory. They can also be build +with: `go build`. + ## Supported RFCs *all of them*