diff options
author | Ingela Anderton Andin <[email protected]> | 2015-05-08 15:47:44 +0200 |
---|---|---|
committer | Ingela Anderton Andin <[email protected]> | 2015-05-08 15:47:44 +0200 |
commit | fad4130bd8844097b6406ddc587b2185de1937fe (patch) | |
tree | 486e71b74d8de66ff7e538523bdfbd4c0b99a081 /lib/public_key/doc/src/introduction.xml | |
parent | ce96ab6d64768cd6536011ccdecc08191c238220 (diff) | |
parent | 631489eb5f989f06de993004ae6db58f07465ccb (diff) | |
download | otp-fad4130bd8844097b6406ddc587b2185de1937fe.tar.gz otp-fad4130bd8844097b6406ddc587b2185de1937fe.tar.bz2 otp-fad4130bd8844097b6406ddc587b2185de1937fe.zip |
Merge branch 'ia/public_key/improve_docs'
* ia/public_key/improve_docs:
public_key: Add clarifications
public_key: Align types with removal of legacy ASN.1 flags
public_key: Align to alphabetical order
public_key: Correct application names and typos
public_key: Change structure to what editor intended
Editorial changes
Diffstat (limited to 'lib/public_key/doc/src/introduction.xml')
-rw-r--r-- | lib/public_key/doc/src/introduction.xml | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/lib/public_key/doc/src/introduction.xml b/lib/public_key/doc/src/introduction.xml index bf11a092d8..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,27 +36,28 @@ <section> <title>Purpose</title> - <p> public_key deals with public key related file formats, digital - signatures and <url href="http://www.ietf.org/rfc/rfc5280.txt"> + <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 - functionality, it does not read or write files it expects or returns + provides encode/decode, sign/verify, encrypt/decrypt, and similar + functionality. It does not read or write files, it expects or returns file contents or partial file contents as binaries. </p> </section> <section> <title>Prerequisites</title> - <p>It is assumed that the reader has a basic understanding - of the concepts of using public keys and digital certificates.</p> + <p>It is assumed that the reader is familiar with the Erlang programming + language and has a basic understanding of the concepts of using public-keys + and digital certificates.</p> </section> <section> - <title>Performance tips</title> - <p>The public_key decode and encode functions will try to use the NIFs - which are in the ASN1 compilers runtime modules if they can be found. - So for the best performance you want to have the ASN1 application in the - path of your system. </p> + <title>Performance Tips</title> + <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> </chapter> |