]> Cypherpunks repositories - gostls13.git/commitdiff
crypto/x509: reformat template members in docs
authorMartin Sucha <anty.sk+git@gmail.com>
Sun, 20 May 2018 19:01:31 +0000 (21:01 +0200)
committerBrad Fitzpatrick <bradfitz@golang.org>
Tue, 22 May 2018 18:29:16 +0000 (18:29 +0000)
It's easier to skim a list of items visually when the
items are each on a separate line. Separate lines also
help reduce diff size when items are added/removed.

The list is indented so that it's displayed preformatted
in HTML output as godoc doesn't support formatting lists
natively yet (see #7873).

Change-Id: Ibf9e92437e4b464ba58ea3ccef579e8df4745d75
Reviewed-on: https://go-review.googlesource.com/113915
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
src/crypto/x509/x509.go

index dcebce320d8a35a67f16bb4681075bebfea12fa1..bb1f94497f4c2b4ea1c6d36f14fb8bc470666168 100644 (file)
@@ -2039,11 +2039,26 @@ func signingParamsForPublicKey(pub interface{}, requestedSigAlgo SignatureAlgori
 var emptyASN1Subject = []byte{0x30, 0}
 
 // CreateCertificate creates a new X.509v3 certificate based on a template.
-// The following members of template are used: AuthorityKeyId,
-// BasicConstraintsValid, DNSNames, ExcludedDNSDomains, ExtKeyUsage,
-// IsCA, KeyUsage, MaxPathLen, MaxPathLenZero, NotAfter, NotBefore,
-// PermittedDNSDomains, PermittedDNSDomainsCritical, SerialNumber,
-// SignatureAlgorithm, Subject, SubjectKeyId, and UnknownExtKeyUsage.
+// The following members of template are used:
+//
+//  - AuthorityKeyId
+//  - BasicConstraintsValid
+//  - DNSNames
+//  - ExcludedDNSDomains
+//  - ExtKeyUsage
+//  - IsCA
+//  - KeyUsage
+//  - MaxPathLen
+//  - MaxPathLenZero
+//  - NotAfter
+//  - NotBefore
+//  - PermittedDNSDomains
+//  - PermittedDNSDomainsCritical
+//  - SerialNumber
+//  - SignatureAlgorithm
+//  - Subject
+//  - SubjectKeyId
+//  - UnknownExtKeyUsage
 //
 // The certificate is signed by parent. If parent is equal to template then the
 // certificate is self-signed. The parameter pub is the public key of the
@@ -2365,9 +2380,18 @@ func parseCSRExtensions(rawAttributes []asn1.RawValue) ([]pkix.Extension, error)
 }
 
 // CreateCertificateRequest creates a new certificate request based on a
-// template. The following members of template are used: Attributes, DNSNames,
-// EmailAddresses, ExtraExtensions, IPAddresses, URIs, SignatureAlgorithm, and
-// Subject. The private key is the private key of the signer.
+// template. The following members of template are used:
+//
+//  - Attributes
+//  - DNSNames
+//  - EmailAddresses
+//  - ExtraExtensions
+//  - IPAddresses
+//  - URIs
+//  - SignatureAlgorithm
+//  - Subject
+//
+// The private key is the private key of the signer.
 //
 // The returned slice is the certificate request in DER encoding.
 //