From: Filippo Valsorda Date: Thu, 10 Jul 2025 15:06:05 +0000 (+0200) Subject: crypto/rsa: fix documentation formatting X-Git-Tag: go1.25rc3~5^2~33 X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=1ca23682dd7b2706daa94e428b3b82cc85a752c0;p=gostls13.git crypto/rsa: fix documentation formatting Change-Id: I6a6a696422f9ab73b9ddee131b17d3c177fefc4e Reviewed-on: https://go-review.googlesource.com/c/go/+/687615 LUCI-TryBot-Result: Go LUCI Reviewed-by: Roland Shoemaker Reviewed-by: Carlos Amedee Auto-Submit: Filippo Valsorda --- diff --git a/src/crypto/rsa/rsa.go b/src/crypto/rsa/rsa.go index 95bb4becd2..d061d9b7a0 100644 --- a/src/crypto/rsa/rsa.go +++ b/src/crypto/rsa/rsa.go @@ -30,14 +30,15 @@ // with a key smaller than 1024 bits. Such keys are insecure and should not be // used. // -// The `rsa1024min=0` GODEBUG setting suppresses this error, but we recommend -// doing so only in tests, if necessary. Tests can use [testing.T.Setenv] or -// include `//go:debug rsa1024min=0` in a `_test.go` source file to set it. +// The rsa1024min=0 GODEBUG setting suppresses this error, but we recommend +// doing so only in tests, if necessary. Tests can set this option using +// [testing.T.Setenv] or by including "//go:debug rsa1024min=0" in a *_test.go +// source file. // // Alternatively, see the [GenerateKey (TestKey)] example for a pregenerated // test-only 2048-bit key. // -// [GenerateKey (TestKey)]: #example-GenerateKey-TestKey +// [GenerateKey (TestKey)]: https://pkg.go.dev/crypto/rsa#example-GenerateKey-TestKey package rsa import ( @@ -226,7 +227,7 @@ type CRTValue struct { // Validate performs basic sanity checks on the key. // It returns nil if the key is valid, or else an error describing a problem. // -// It runs faster on valid keys if run after [Precompute]. +// It runs faster on valid keys if run after [PrivateKey.Precompute]. func (priv *PrivateKey) Validate() error { // We can operate on keys based on d alone, but it isn't possible to encode // with [crypto/x509.MarshalPKCS1PrivateKey], which unfortunately doesn't @@ -274,7 +275,7 @@ func checkPublicKeySize(k *PublicKey) error { // returned key does not depend deterministically on the bytes read from rand, // and may change between calls and/or between versions. // -// [Minimum key size]: #hdr-Minimum_key_size +// [Minimum key size]: https://pkg.go.dev/crypto/rsa#hdr-Minimum_key_size func GenerateKey(random io.Reader, bits int) (*PrivateKey, error) { if err := checkKeySize(bits); err != nil { return nil, err