From 631489eb5f989f06de993004ae6db58f07465ccb Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Thu, 7 May 2015 14:09:35 +0200
Subject: public_key: Add clarifications

---
 lib/public_key/doc/src/records.xml          | 17 ++++++++++++++---
 lib/public_key/doc/src/using_public_key.xml |  4 +++-
 2 files changed, 17 insertions(+), 4 deletions(-)

(limited to 'lib/public_key/doc/src')

diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml
index e9e9b231af..9536167839 100644
--- a/lib/public_key/doc/src/records.xml
+++ b/lib/public_key/doc/src/records.xml
@@ -96,6 +96,15 @@
       <p><c>| privilegeWithdrawn</c></p>
       <p><c>| aACompromise</c></p>
       </item>
+
+      <tag><c>OID_macro()</c></tag>
+      <item>= <p><c>?OID_name() </c></p>
+      </item>
+      
+      <tag><c>OID_name()</c></tag>
+      <item>= <p><c>atom()</c></p>
+      </item>
+      
     </taglist>
 
   </section>
@@ -196,7 +205,7 @@
   <section>
     <title>PKIX Certificates</title>   
     <p>Erlang representation of PKIX certificates derived from ASN.1 
-    specifications see also <url href="http://www.ietf.org/rfc/rfc5280.txt">X509 certificates (RFC 5280)</url> are as follows:</p>
+    specifications see also <url href="http://www.ietf.org/rfc/rfc5280.txt">X509 certificates (RFC 5280)</url>, also referred to as <c>plain</c> type,  are as follows:</p>
 <code>
 #'Certificate'{
 		tbsCertificate,        % #'TBSCertificate'{}
@@ -222,6 +231,8 @@
 	  parameters  % der_encoded()
 	 }.</code>
 
+<p>Erlang alternate representation of PKIX certificate, also referred to as <c>otp</c> type</p>
+	 
 <code>
 #'OTPCertificate'{
 		tbsCertificate,        % #'OTPTBSCertificate'{}
@@ -247,8 +258,8 @@
 	  parameters  % asn1_novalue | #'Dss-Parms'{}
 	 }.</code>
 
-<p>Here, <c>id_signature_algorithm()</c> = ?OID name, for available OID names, for example 
-<c>?id-dsa-with-sha1</c>. That is, by prepending "?" to the OID name, represented as an Erlang atom.</p>
+<p><c>id_signature_algorithm() = OID_macro()</c></p>
+
 <p>The available OID names are as follows:</p>
 <table>
   <row>
diff --git a/lib/public_key/doc/src/using_public_key.xml b/lib/public_key/doc/src/using_public_key.xml
index 41a81b6dea..03e4bedf3d 100644
--- a/lib/public_key/doc/src/using_public_key.xml
+++ b/lib/public_key/doc/src/using_public_key.xml
@@ -381,7 +381,9 @@ Msg = public_key:decrypt_public(RsaEncrypted, PublicKey),</code>
 Msg = public_key:decrypt_private(RsaEncrypted, PrivateKey),</code>
 
       <note><p>You normally do only one of the encrypt or decrypt operations, 
-      and the peer does the other.</p></note>
+      and the peer does the other. This normaly used in legacy applications
+      as a primitive digital signature.
+      </p></note>
 
   </section>
 
-- 
cgit v1.2.3