[gentoo-commits] gentoo-x86 commit in eclass: ssl-cert.eclass

[Ulrich Mueller (ulm)]

ulm         08/04/14 06:37:44

  Modified:             ssl-cert.eclass
  Log:
  Add magic comments for eclass-manpages.

Revision  Changes    Path
1.16                 eclass/ssl-cert.eclass

file : http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/ssl-cert.eclass?rev=1.16&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/ssl-cert.eclass?rev=1.16&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/ssl-cert.eclass?r1=1.15&r2=1.16

Index: ssl-cert.eclass
===================================================================
RCS file: /var/cvsroot/gentoo-x86/eclass/ssl-cert.eclass,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- ssl-cert.eclass	14 Apr 2008 06:27:45 -0000	1.15
+++ ssl-cert.eclass	14 Apr 2008 06:37:44 -0000	1.16
@@ -1,17 +1,25 @@
 # Copyright 1999-2004 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/ssl-cert.eclass,v 1.15 2008/04/14 06:27:45 ulm Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/ssl-cert.eclass,v 1.16 2008/04/14 06:37:44 ulm Exp $
 #
+# @ECLASS: ssl-cert.eclass
+# @MAINTAINER:
 # Author: Max Kalika <max@g.o>
-#
-# This eclass implements standard installation procedure for installing
+# @BLURB: Eclass for SSL certificates
+# @DESCRIPTION:
+# This eclass implements a standard installation procedure for installing
 # self-signed SSL certificates.
+# @EXAMPLE:
+# "install_cert /foo/bar" installs ${ROOT}/foo/bar.{key,csr,crt,pem}
 
 # Conditionally depend on OpenSSL: allows inheretence
 # without pulling extra packages if not needed
 DEPEND="ssl? ( dev-libs/openssl )"
 IUSE="ssl"
 
+# @FUNCTION: gen_cnf
+# @USAGE:
+# @DESCRIPTION:
 # Initializes variables and generates the needed
 # OpenSSL configuration file and a CA serial file
 #
@@ -60,6 +68,10 @@
 	return $?
 }
 
+# @FUNCTION: get_base
+# @USAGE: [if_ca]
+# @RETURN: <base path>
+# @DESCRIPTION:
 # Simple function to determine whether we're creating
 # a CA (which should only be done once) or final part
 #
@@ -72,6 +84,9 @@
 	fi
 }
 
+# @FUNCTION: gen_key
+# @USAGE: <base path>
+# @DESCRIPTION:
 # Generates an RSA key
 #
 # Access: private
@@ -85,6 +100,9 @@
 	return $?
 }
 
+# @FUNCTION: gen_csr
+# @USAGE: <base path>
+# @DESCRIPTION:
 # Generates a certificate signing request using
 # the key made by gen_key()
 #
@@ -99,6 +117,9 @@
 	return $?
 }
 
+# @FUNCTION: gen_crt
+# @USAGE: <base path>
+# @DESCRIPTION:
 # Generates either a self-signed CA certificate using
 # the csr and key made by gen_csr() and gen_key() or
 # a signed server certificate using the CA cert previously
@@ -125,6 +146,9 @@
 	return $?
 }
 
+# @FUNCTION: gen_pem
+# @USAGE: <base path>
+# @DESCRIPTION:
 # Generates a PEM file by concatinating the key
 # and cert file created by gen_key() and gen_cert()
 #
@@ -145,11 +169,12 @@
 	die
 }
 
-# Uses all the private functions above to generate
-# and install the requested certificates
-#
-# Usage: install_cert <certificates>
-# where <certificates> are full pathnames relative to ROOT, without extension.
+# @FUNCTION: install_cert
+# @USAGE: <certificates>
+# @DESCRIPTION:
+# Uses all the private functions above to generate and install the
+# requested certificates.
+# <certificates> are full pathnames relative to ROOT, without extension.
 #
 # Example: "install_cert /foo/bar" installs ${ROOT}/foo/bar.{key,csr,crt,pem}
 #



-- 
gentoo-commits@l.g.o mailing list