From: Leigh McCulloch <leighmcc@gmail.com>
Date: Thu, 30 Aug 2018 21:45:21 +0000 (+0000)
Subject: crypto/x509: clarify docs for SystemCertPool
X-Git-Tag: go1.12beta1~1205
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=8201b92aae7ba51ed2e2645c1f7815bfe845db72;p=gostls13.git

crypto/x509: clarify docs for SystemCertPool

The sentence in the docs for SystemCertPool that states that mutations
to a returned pool do not affect any other pool is ambiguous as to who
the any other pools are, because pools can be created in multiple ways
that have nothing to do with the system certificate pool. Also the use
of the word 'the' instead of 'a' early in the sentence implies there is
only one shared pool ever returned.

Fixes #27385

Change-Id: I43adbfca26fdd66c4adbf06eb85361139a1dea93
GitHub-Last-Rev: 2f1ba09fa403d31d2d543dca15727c6c2f896ec7
GitHub-Pull-Request: golang/go#27388
Reviewed-on: https://go-review.googlesource.com/132378
Reviewed-by: Filippo Valsorda <filippo@golang.org>
---

diff --git a/src/crypto/x509/cert_pool.go b/src/crypto/x509/cert_pool.go
index a1646b9826..5381f0d659 100644
--- a/src/crypto/x509/cert_pool.go
+++ b/src/crypto/x509/cert_pool.go
@@ -47,8 +47,8 @@ func (s *CertPool) copy() *CertPool {
 
 // SystemCertPool returns a copy of the system cert pool.
 //
-// Any mutations to the returned pool are not written to disk and do
-// not affect any other pool.
+// Any mutations to a returned pool are not written to disk and do
+// not affect any other pool returned by SystemCertPool.
 //
 // New changes in the the system cert pool might not be reflected
 // in subsequent calls.