File 1250-public_key-Create-application-manual-page-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1250-public_key-Create-application-manual-page-that-is-ma.patch of Package erlang (Revision 20341d3ca8beab07b502d76ce8eb2b1a)

Currently displaying revision 20341d3ca8beab07b502d76ce8eb2b1a , Show latest

From 977842a257f4d5e1753bde0c641978f4e4880c0c Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Fri, 3 Jun 2016 15:39:20 +0200
Subject: [PATCH] public_key: Create application manual page that is man(6)

---
 lib/public_key/doc/src/Makefile           | 11 ++--
 lib/public_key/doc/src/public_key.xml     | 33 ++----------
 lib/public_key/doc/src/public_key_app.xml | 85 +++++++++++++++++++++++++++++++
 lib/public_key/doc/src/ref_man.xml        |  1 +
 4 files changed, 97 insertions(+), 33 deletions(-)
 create mode 100644 lib/public_key/doc/src/public_key_app.xml

diff --git a/lib/public_key/doc/src/Makefile b/lib/public_key/doc/src/Makefile
index f3db24a..5bdc5d4 100644
--- a/lib/public_key/doc/src/Makefile
+++ b/lib/public_key/doc/src/Makefile
@@ -38,7 +38,7 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN)
 # ----------------------------------------------------
 XML_APPLICATION_FILES = ref_man.xml
 XML_REF3_FILES = public_key.xml
-XML_REF6_FILES =
+XML_REF6_FILES = public_key_app.xml
 
 XML_PART_FILES = part.xml part_notes.xml
 XML_CHAPTER_FILES = \
@@ -50,7 +50,7 @@ XML_CHAPTER_FILES = \
 BOOK_FILES = book.xml
 
 XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \
-            $(XML_PART_FILES) $(XML_CHAPTER_FILES) 
+             $(XML_REF6_FILES) $(XML_PART_FILES) $(XML_CHAPTER_FILES) 
 
 GIF_FILES = note.gif
 
@@ -67,9 +67,11 @@ EXTRA_FILES = \
 	$(DEFAULT_GIF_FILES) \
 	$(DEFAULT_HTML_FILES) \
 	$(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) \
+	$(XML_REF6_FILES:%.xml=$(HTMLDIR)/%.html) \
 	$(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html)
 
 MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3)
+MAN6_FILES = $(XML_REF6_FILES:%_app.xml=$(MAN6DIR)/%.6)
 
 HTML_REF_MAN_FILE = $(HTMLDIR)/index.html
 
@@ -98,10 +100,11 @@ html: gifs $(HTML_REF_MAN_FILE)
 clean clean_docs:
 	rm -rf $(HTMLDIR)/*
 	rm -f $(MAN3DIR)/*
+	rm -f $(MAN6DIR)/*
 	rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo)
 	rm -f errs core *~
 
-man: $(MAN3_FILES)
+man: $(MAN3_FILES) $(MAN6_FILES)
 
 gifs: $(GIF_FILES:%=$(HTMLDIR)/%)
 
@@ -122,6 +125,8 @@ release_docs_spec: docs
 	$(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)"
 	$(INSTALL_DIR) "$(RELEASE_PATH)/man/man3"
 	$(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3"
+	$(INSTALL_DIR) "$(RELEASE_PATH)/man/man6"
+	$(INSTALL_DATA) $(MAN6DIR)/* "$(RELEASE_PATH)/man/man6"
 release_spec:
 
 info:
diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index 04daee4..1aa601d 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -34,40 +34,13 @@
   <module>public_key</module>
   <modulesummary>API module for public-key infrastructure.</modulesummary>
   <description>
-    <p>This module provides functions to handle public-key infrastructure. It can
-    encode/decode different file formats (PEM, OpenSSH), sign and verify digital signatures, 
-    and validate certificate paths and certificate revocation lists.
+    <p>Provides functions to handle public-key infrastructure,
+    for details see
+    <seealso marker="public_key_app">public_key(6)</seealso>.
     </p>
   </description>
 
   <section>
-    <title>public_key</title>
-
-    <list type="bulleted">
-      <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 
-      (CRL) Profile </item>
-      <item>Supports <url href="http://www.ietf.org/rfc/rfc3447.txt"> PKCS-1 </url> - 
-      RSA Cryptography Standard </item>
-      <item>Supports <url href="http://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf"> DSS</url> - 
-      Digital Signature Standard (DSA - Digital Signature Algorithm)</item>
-      <item>Supports 
-      <url href="http://www.emc.com/emc-plus/rsa-labs/standards-initiatives/pkcs-3-diffie-hellman-key-agreement-standar.htm"> PKCS-3 </url> - 
-      Diffie-Hellman Key Agreement Standard </item>
-      <item>Supports <url href="http://www.ietf.org/rfc/rfc2898.txt"> PKCS-5</url> - 
-      Password-Based Cryptography Standard </item>
-      <item>Supports <url href="http://www.ietf.org/rfc/rfc5208.txt"> PKCS-8</url> - 
-      Private-Key Information Syntax Standard</item>
-      <item>Supports <url href="http://www.ietf.org/rfc/rfc5967.txt"> PKCS-10</url> - 
-      Certification Request Syntax Standard</item>
-    </list>
-  </section>
-
-  <section>
     <title>DATA TYPES</title> 
     
     <note><p>All records used in this Reference Manual 
diff --git a/lib/public_key/doc/src/public_key_app.xml b/lib/public_key/doc/src/public_key_app.xml
new file mode 100644
index 0000000..1f87932
--- /dev/null
+++ b/lib/public_key/doc/src/public_key_app.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE appref SYSTEM "appref.dtd">
+
+<appref>
+  <header>
+    <copyright>
+      <year>2016</year><year>2016</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+ 
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.
+
+    </legalnotice>
+
+    <title>public_key</title>
+    <prepared></prepared>
+    <docno></docno>
+    <date></date>
+    <rev></rev>
+    <file>public_key_app.sgml</file>
+  </header>
+  <app>public_key</app>
+  <appsummary>Provides functions to handle public-key infrastructure. </appsummary>
+  <description>
+    
+    <p> Provides encode/decode of different file formats (PEM, OpenSSH),
+    digital signature and verification functions, 
+    validation of certificate paths and certificate revocation lists (CRLs) and
+    other functions for handling of certificates, keys and CRLs.</p>
+
+    <list type="bulleted">
+      <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 
+      (CRL) Profile. Certificate policies are currently not supported. </item>
+      <item>Supports <url href="http://www.ietf.org/rfc/rfc3447.txt"> PKCS-1 </url> - 
+      RSA Cryptography Standard </item>
+      <item>Supports <url href="http://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf"> DSS</url> - 
+      Digital Signature Standard (DSA - Digital Signature Algorithm)</item>
+      <item>Supports 
+      <url href="http://www.emc.com/emc-plus/rsa-labs/standards-initiatives/pkcs-3-diffie-hellman-key-agreement-standar.htm"> PKCS-3 </url> - 
+      Diffie-Hellman Key Agreement Standard </item>
+      <item>Supports <url href="http://www.ietf.org/rfc/rfc2898.txt"> PKCS-5</url> - 
+      Password-Based Cryptography Standard </item>
+      <item>Supports <url href="http://www.ietf.org/rfc/rfc5208.txt"> PKCS-8</url> - 
+      Private-Key Information Syntax Standard</item>
+      <item>Supports <url href="http://www.ietf.org/rfc/rfc5967.txt"> PKCS-10</url> - 
+      Certification Request Syntax Standard</item>
+    </list>
+   </description>
+
+  <section>
+    <title>DEPENDENCIES</title>
+    <p>The <c>public_key</c> application uses the 
+    Crypto application to preform cryptographic operations and the
+    ASN-1 application to handle PKIX-ASN-1 specifications, hence
+    these applications must be loaded for the <c>public_key</c> application to work. 
+    In an embedded environment this means they must be started with
+    <c>application:start/[1,2]</c> before the <c>public_key</c> application is 
+    started.</p>
+  </section>
+ 
+  <section>
+    <title>ERROR LOGGER AND EVENT HANDLERS</title>
+    <p> The <c>public_key</c> application is a library application
+    and does not use the error logger. The functions will either sucssed
+    or fail with a runtime error.
+    </p>
+  </section>
+
+  <section>
+    <title>SEE ALSO</title>
+	<p><seealso marker="kernel:application">application(3)</seealso></p>
+  </section>
+  
+</appref>
diff --git a/lib/public_key/doc/src/ref_man.xml b/lib/public_key/doc/src/ref_man.xml
index 75c5374..2bd1733 100644
--- a/lib/public_key/doc/src/ref_man.xml
+++ b/lib/public_key/doc/src/ref_man.xml
@@ -36,6 +36,7 @@
     from RFC 3280 (X.509 certificates) and parts of the PKCS standard.
     </p>
   </description>
+  <xi:include href="public_key_app.xml"/>
   <xi:include href="public_key.xml"/>
 </application>
 
-- 
2.1.4

Places

File 1250-public_key-Create-application-manual-page-that-is-ma.patch of Package erlang (Revision 20341d3ca8beab07b502d76ce8eb2b1a)

Places