diff options
author | Aaron W. Swenson <titanofold@gentoo.org> | 2017-09-05 11:35:01 -0400 |
---|---|---|
committer | Aaron W. Swenson <titanofold@gentoo.org> | 2017-09-05 11:35:01 -0400 |
commit | ef54a0b63c9dccd609adc771c0ec16c5af5b789b (patch) | |
tree | c759aebd7003b7e678ed7e114f610798281cc910 /postgres.eclass | |
parent | Use Simple Sort (diff) | |
download | eclass-master.tar.gz eclass-master.tar.bz2 eclass-master.zip |
Improve documentation to address eclass-to-manpage.sh warnings, and to
clean up manpage output.
Diffstat (limited to 'postgres.eclass')
-rw-r--r-- | postgres.eclass | 36 |
1 files changed, 22 insertions, 14 deletions
diff --git a/postgres.eclass b/postgres.eclass index e5a9b6f..2f89da1 100644 --- a/postgres.eclass +++ b/postgres.eclass @@ -35,20 +35,27 @@ _POSTGRES_ALL_VERSIONS=( 11 10 9.6 9.5 9.4 9.3 9.2 ) # @DESCRIPTION: # A Bash array containing a list of compatible PostgreSQL slots as # defined by the developer. If declared, must be declared before -# inheriting this eclass. Example: POSTGRES_COMPAT=( 9.4 9.{5,6} ) - -# @ECLASS-VARIABLE: POSTGRES_USEDEP -# @DEFAULT_UNSET -# @DESCRIPTION: -# Add the 2-Style and/or 4-Style use dependencies without brackets to be used -# for POSTGRES_DEP. If declared, must be done before inheriting this eclass. +# inheriting this eclass. Example: +#@CODE +#POSTGRES_COMPAT=( 9.2 9.3 9.4 9.5 9.6 10 ) +#POSTGRES_COMPAT=( 9.{2,3} 9.{4..6} 10 ) # Same as previous +#@CODE # @ECLASS-VARIABLE: POSTGRES_DEP # @DESCRIPTION: # An automatically generated dependency string suitable for use in # DEPEND and RDEPEND declarations. +POSTGRES_DEP="dev-db/postgresql:=" + +# @ECLASS-VARIABLE: POSTGRES_USEDEP +# @DEFAULT_UNSET +# @DESCRIPTION: +# Add the 2-Style and/or 4-Style use dependencies without brackets to be used +# for POSTGRES_DEP. If declared, must be declared before inheriting this eclass. +declare -p POSTGRES_USEDEP &>/dev/null && POSTGRES_DEP+="[${POSTGRES_USEDEP}]" # @ECLASS-VARIABLE: POSTGRES_REQ_USE +# @DEFAULT_UNSET # @DESCRIPTION: # An automatically generated REQUIRED_USE-compatible string built upon # POSTGRES_COMPAT. REQUIRED_USE="... ${POSTGRES_REQ_USE}" is only @@ -82,10 +89,6 @@ if declare -p POSTGRES_COMPAT &> /dev/null ; then POSTGRES_REQ_USE+=" postgres_targets_postgres${slot/\./_}" done POSTGRES_REQ_USE+=" )" -else - POSTGRES_DEP="dev-db/postgresql:=" - declare -p POSTGRES_USEDEP &>/dev/null && \ - POSTGRES_DEP+="[${POSTGRES_USEDEP}]" fi @@ -113,10 +116,16 @@ postgres_check_slot() { } # @FUNCTION: postgres_new_user +# @USAGE: [user [(uid|-1) [(shell|-1) [(homedir|-1) [groups]]]]] # @DESCRIPTION: # Creates the "postgres" system group and user -- which is separate from -# the database user -- in addition to the developer defined user. Takes -# the same arguments as "enewuser". +# the database user -- and, optionally, the developer defined user. There +# are no required parameters. +# +# When given a user to create, it'll be created with the next available +# uid, default shell set to /bin/false, default homedir is /dev/null, +# and added to the "postgres" system group. You can use "-1" to skip any +# parameter except user or groups. postgres_new_user() { enewgroup postgres 70 enewuser postgres 70 /bin/bash /var/lib/postgresql postgres @@ -133,7 +142,6 @@ postgres_new_user() { } # @FUNCTION: postgres_pkg_setup -# @USAGE: postgres_pkg_setup # @DESCRIPTION: # Initialize environment variable(s) according to the best # installed version of PostgreSQL that is also in POSTGRES_COMPAT. This |