Browse Source

doc: replace markdown backticks with perlpod syntax

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16190)
Beat Bolli 2 years ago
parent
commit
da496bc159

+ 2 - 2
doc/internal/man7/deprecation.pod

@@ -21,10 +21,10 @@ Removal of a symbol is not the same thing as deprecation, as it actually
 explicitly removes the symbol from public view.
 
 OpenSSL configuration supports deprecation as well as simulating removal of
-symbols from public view (with the configuration option `no-deprecated`, or
+symbols from public view (with the configuration option C<no-deprecated>, or
 if the user chooses to do so, with L<OPENSSL_NO_DEPRECATED(7)>), and also
 supports doing this in terms of a specified OpenSSL version (with the
-configuration option `--api`, or if the user chooses to do so, with
+configuration option C<--api>, or if the user chooses to do so, with
 L<OPENSSL_API_COMPAT(7)>).
 
 Deprecation is done using attribute macros named

+ 1 - 1
doc/man1/openssl-ocsp.pod.in

@@ -371,7 +371,7 @@ subject name.
 
 Port to listen for OCSP requests on. The port may also be specified
 using the B<url> option.
-A `0` argument indicates that any available port shall be chosen automatically.
+A C<0> argument indicates that any available port shall be chosen automatically.
 
 =item B<-ignore_err>
 

+ 1 - 1
doc/man3/OSSL_STORE_INFO.pod

@@ -108,7 +108,7 @@ OSSL_STORE_INFO_new_CERT() and OSSL_STORE_INFO_new_CRL()
 create a B<OSSL_STORE_INFO> object to hold the given input object.
 On success the input object is consumed.
 
-Additionally, for B<OSSL_STORE_INFO_NAME>` objects,
+Additionally, for B<OSSL_STORE_INFO_NAME> objects,
 OSSL_STORE_INFO_set0_NAME_description() can be used to add an extra
 description.
 This description is meant to be human readable and should be used for

+ 3 - 3
doc/man7/migration_guide.pod

@@ -369,8 +369,8 @@ curve ones.
 Validation of SM2 keys has been separated from the validation of regular EC
 keys, allowing to improve the SM2 validation process to reject loaded private
 keys that are not conforming to the SM2 ISO standard.
-In particular, a private scalar `k` outside the range `1 <= k < n-1` is now
-correctly rejected.
+In particular, a private scalar I<k> outside the range I<< 1 <= k < n-1 >> is
+now correctly rejected.
 
 =head4 EVP_PKEY_set_alias_type() method has been removed
 
@@ -2324,7 +2324,7 @@ The security strength of SHA1 and MD5 based signatures in TLS has been reduced.
 This results in SSL 3, TLS 1.0, TLS 1.1 and DTLS 1.0 no longer
 working at the default security level of 1 and instead requires security
 level 0. The security level can be changed either using the cipher string
-with `C<@SECLEVEL>, or calling L<SSL_CTX_set_security_level(3)>. This also means
+with C<@SECLEVEL>, or calling L<SSL_CTX_set_security_level(3)>. This also means
 that where the signature algorithms extension is missing from a ClientHello
 then the handshake will fail in TLS 1.2 at security level 1. This is because,
 although this extension is optional, failing to provide one means that

+ 1 - 1
doc/man7/passphrase-encoding.pod

@@ -105,7 +105,7 @@ Also note that the sub-sections below discuss human readable pass phrases.
 This is particularly relevant for PKCS#12 objects, where human readable pass
 phrases are assumed.
 For other objects, it's as legitimate to use any byte sequence (such as a
-sequence of bytes from `/dev/urandom` that's been saved away), which makes any
+sequence of bytes from F</dev/urandom> that's been saved away), which makes any
 character encoding discussion irrelevant; in such cases, simply use the same
 byte sequence as it is.