diff options
author | Ingela Anderton Andin <[email protected]> | 2015-05-07 13:29:16 +0200 |
---|---|---|
committer | Ingela Anderton Andin <[email protected]> | 2015-05-07 15:50:56 +0200 |
commit | d34eab98d034598f2e9ed96c8e3aa992cb633bc8 (patch) | |
tree | be18e1b7e0816b12da28ee68f8cf11ed7097a362 /lib/public_key/doc | |
parent | 25575183ca581a080478ad499e308a76e44e4def (diff) | |
download | otp-d34eab98d034598f2e9ed96c8e3aa992cb633bc8.tar.gz otp-d34eab98d034598f2e9ed96c8e3aa992cb633bc8.tar.bz2 otp-d34eab98d034598f2e9ed96c8e3aa992cb633bc8.zip |
public_key: Correct application names and typos
Diffstat (limited to 'lib/public_key/doc')
-rw-r--r-- | lib/public_key/doc/src/introduction.xml | 10 | ||||
-rw-r--r-- | lib/public_key/doc/src/public_key.xml | 12 | ||||
-rw-r--r-- | lib/public_key/doc/src/records.xml | 6 | ||||
-rw-r--r-- | lib/public_key/doc/src/using_public_key.xml | 25 |
4 files changed, 27 insertions, 26 deletions
diff --git a/lib/public_key/doc/src/introduction.xml b/lib/public_key/doc/src/introduction.xml index 17f4e5155a..6542c8c509 100644 --- a/lib/public_key/doc/src/introduction.xml +++ b/lib/public_key/doc/src/introduction.xml @@ -5,7 +5,7 @@ <header> <copyright> <year>2008</year> - <year>2013</year> + <year>2015</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> @@ -36,7 +36,7 @@ <section> <title>Purpose</title> - <p>The <c>public_key</c> application deals with public-key related file + <p>The Public Key application deals with public-key related file formats, digital signatures, and <url href="http://www.ietf.org/rfc/rfc5280.txt"> X-509 certificates</url>. It is a library application that provides encode/decode, sign/verify, encrypt/decrypt, and similar @@ -54,9 +54,9 @@ <section> <title>Performance Tips</title> - <p>The <c>public_key</c> decode- and encode-functions try to use the NIFs - in the <c>ASN.1</c> compilers runtime modules, if they can be found. - Thus, to have the <c>ASN.1</c> application in the + <p>The Public Key decode- and encode-functions try to use the NIFs + in the ASN.1 compilers runtime modules, if they can be found. + Thus, to have the ASN1 application in the path of your system gives the best performance.</p> </section> diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 3d5c135075..8a81593341 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -43,9 +43,9 @@ <title>public_key</title> <list type="bulleted"> - <item><c>public_key</c> requires the <c>crypto</c> and <c>ASN.1</c> applications, - the latter as OTP R16 (hopefully the runtime dependency on <c>ASN.1</c> will - be removed again in the future).</item> + <item> Public Key requires the Crypto and ASN1 applications, + the latter as OTP R16 (hopefully the runtime dependency on ASN1 will + be removed again in the future).</item> <item>Supports <url href="http://www.ietf.org/rfc/rfc5280.txt">RFC 5280 </url> - Internet X.509 Public-Key Infrastructure Certificate and Certificate Revocation List @@ -268,7 +268,7 @@ <fsummary>Decodes a public-key ASN.1 DER encoded entity.</fsummary> <type> <v>Asn1Type = atom()</v> - <d>ASN.1 type present in the <c>public_key</c> applications + <d>ASN.1 type present in the Public Key applications ASN.1 specifications.</d> <v>Der = der_encoded()</v> </type> @@ -282,7 +282,7 @@ <fsummary>Encodes a public-key entity with ASN.1 DER encoding.</fsummary> <type> <v>Asn1Type = atom()</v> - <d>ASN.1 type present in the public_key applications + <d>ASN.1 type present in the Public Key applications ASN.1 specifications.</d> <v>Entity = term()</v> <d>Erlang representation of <c>Asn1Type</c></d> @@ -626,7 +626,7 @@ fun(OtpCert :: #'OTPCertificate'{}, <p>The fun uses the information in the distribution point to access the latest possible version of the CRL. If this fun is not specified, - <c>public_key</c> uses the default implementation: + Public Key uses the default implementation: </p> <code> fun(_DP, CRL) -> CRL end</code> </item> diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml index ac1ecd176c..0090278da8 100644 --- a/lib/public_key/doc/src/records.xml +++ b/lib/public_key/doc/src/records.xml @@ -5,7 +5,7 @@ <header> <copyright> <year>2008</year> - <year>2014</year> + <year>2015</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> @@ -50,7 +50,7 @@ <p>Common non-standard Erlang data types used to describe the record fields in the - following sections and which are not defined in the <c>public_key</c> <seealso + following sections and which are not defined in the Public Key <seealso marker="public_key">Reference Manual</seealso> follows here:</p> @@ -772,7 +772,7 @@ are as follows:</p> <p>Here:</p> <taglist> <tag><c>crl_reason()</c></tag> - <item>= <p><c>unspecified</c>c></p> + <item>= <p><c>unspecified</c></p> <p><c>| keyCompromise</c></p> <p><c>| cACompromise</c></p> <p><c>| affiliationChanged</c></p> diff --git a/lib/public_key/doc/src/using_public_key.xml b/lib/public_key/doc/src/using_public_key.xml index 69b8c0dcb9..aaf802cd34 100644 --- a/lib/public_key/doc/src/using_public_key.xml +++ b/lib/public_key/doc/src/using_public_key.xml @@ -30,8 +30,8 @@ </header> <p>This section describes examples of how to use the - <c>public_key</c> API. Keys and certificates used in the following - sections are generated only for testing the <c>public_key</c> + Public Key API. Keys and certificates used in the following + sections are generated only for testing the Public Key application.</p> <p>Some shell printouts in the following examples @@ -43,14 +43,15 @@ <p>Public-key data (keys, certificates, and so on) can be stored in Privacy Enhanced Mail (PEM) format. The PEM files have the following structure:</p> - - <code><text> - -----BEGIN <SOMETHING>----- - <Attribute> : <Value> - <Base64 encoded DER data> - -----END <SOMETHING>----- - <text></code> - + + <code> + <text> + -----BEGIN <SOMETHING>----- + <Attribute> : <Value> + <Base64 encoded DER data> + -----END <SOMETHING>----- + <text></code> + <p>A file can contain several <c>BEGIN/END</c> blocks. Text lines between blocks are ignored. Attributes, if present, are ignored except for <c>Proc-Type</c> and <c>DEK-Info</c>, which are used when <c>DER</c> @@ -59,7 +60,7 @@ <section> <title>DSA Private Key</title> <p>A DSA private key can look as follows:</p> - <note><p>File handling is not done by the <c>public_key</c> application.</p></note> + <note><p>File handling is not done by the Public Key application.</p></note> <code>1> {ok, PemBin} = file:read_file("dsa.pem"). {ok,<<"-----BEGIN DSA PRIVATE KEY-----\nMIIBuw"...>>}</code> @@ -364,7 +365,7 @@ ok</code> <section> <title>RSA Public-Key Cryptography</title> - <p>Suppose you have the followwing private key and a corresponding public key:</p> + <p>Suppose you have the following private key and a corresponding public key:</p> <list type="bulleted"> <item><c>PrivateKey = #'RSAPrivateKey{}'</c> and the plaintext <c>Msg = binary()</c></item> |