[gentoo-commits] proj/eselect-php:master commit in: src/

[Michael Orlitzky]

commit:     c09a74e0b46e3cd72c5057d23b2ec2038b82a6f0
Author:     Michael Orlitzky <mjo <AT> gentoo <DOT> org>
AuthorDate: Thu Dec 10 14:02:45 2015 +0000
Commit:     Michael Orlitzky <mjo <AT> gentoo <DOT> org>
CommitDate: Thu Dec 10 14:02:45 2015 +0000
URL:        https://gitweb.gentoo.org/proj/eselect-php.git/commit/?id=c09a74e0

Document the find_targets_apache2() and get_active_apache2() functions.

 src/php.eselect.in | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/src/php.eselect.in b/src/php.eselect.in
index 5bbb491..e08afbe 100644
--- a/src/php.eselect.in
+++ b/src/php.eselect.in
@@ -82,6 +82,22 @@ find_targets() {
   echo $dirs
 }
 
+# List all valid apache2 targets. The list is obtained by searching
+# for libphp*.so in locations determined by find_targets(). This list
+# should therefore be a subset of find_targets().
+#
+# INPUT:
+#
+# None.
+#
+# OUTPUT:
+#
+# The "display name" of every available apache PHP module, one per line.
+# For example,
+#
+#   php5.6
+#   php7.0
+#
 find_targets_apache2() {
        local libs target libdir
        for target in $(find_targets); do
@@ -143,6 +159,18 @@ get_active_fpm() {
 }
 
 
+# Find the active (selected) version of the apache2 module. Used to
+# decorate the output of the `eselect php list apache2` command.
+#
+# INPUT:
+#
+# None.
+#
+# OUTPUT:
+#
+# The "display name" of the active apache2 module. For example,
+# "php5.6" or "php7.0".
+#
 get_active_apache2() {
        local libs target ver
        libs="${EROOT}$(get_active_libdir)/apache2/modules/libphp[57].so"