[patch] bash-completion.eclass.patch

bash-completion.eclass.patch (text/plain), 2.21 KB, created by mren on 2008-02-19 00:46:49 UTC

--- bash-completion.eclass.orig	2008-02-19 01:32:10.000000000 +0100
+++ bash-completion.eclass	2008-02-19 01:43:35.000000000 +0100
@@ -1,14 +1,21 @@
-# Copyright 1999-2005 Gentoo Foundation
+# Copyright 1999-2008 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/bash-completion.eclass,v 1.16 2005/07/31 12:38:22 ka0ttic Exp $
+# $Header: $
+
+# @ECLASS: bash-completion.eclass
+# @MAINTAINER:
+# [e-mail].
 #
+# Original author: Aaron Walker <[e-mail]>
+# @BLURB: An Interface for installing contributed bash-completion scripts
+# @DESCRIPTION:
 # Simple eclass that provides an interface for installing
 # contributed (ie not included in bash-completion proper)
 # bash-completion scripts.
-#
-# Author: Aaron Walker <[e-mail]>
-#
-# Please assign any bug reports to [e-mail].
+
+# @ECLASS-VARIABLE: BASH_COMPLETION_NAME
+# @DESCRIPTION:
+# Install the completion script with this name (see also dobashcompletion)
 
 EXPORT_FUNCTIONS pkg_postinst
 
@@ -23,15 +30,16 @@
 			)
 		)"
 
-# dobashcompletion <file> <new file>
-#	First arg, <file>, is required and is the location of the bash-completion
+# @FUNCTION: dobashcompletion
+# @USAGE: < file > [ new_file ]
+# @DESCRIPTION:
+# First arg, <file>, is required and is the location of the bash-completion
 # script to install.  If the variable BASH_COMPLETION_NAME is set in the
 # ebuild, dobashcompletion will install <file> as
 # /usr/share/bash-completion/$BASH_COMPLETION_NAME. If it is not set,
-# dobashcompletion will check if a second arg ($2) was passed, installing as
+# dobashcompletion will check if a second arg [new_file] was passed, installing as
 # the specified name.  Failing both these checks, dobashcompletion will
 # install the file as /usr/share/bash-completion/${PN}.
-
 dobashcompletion() {
 	[[ -z "$1" ]] && die "usage: dobashcompletion <file> <new file>"
 	[[ -z "${BASH_COMPLETION_NAME}" ]] && BASH_COMPLETION_NAME="${2:-${PN}}"
@@ -42,6 +50,9 @@
 	fi
 }
 
+# @FUNCTION: bash-completion_pkg_postinst
+# @DESCRIPTION:
+# The bash-completion pkg_postinst function, which is exported
 bash-completion_pkg_postinst() {
 	if useq bash-completion ; then
 		echo