Use "Returns:" vs. "Return:" in function documentation.

6 files changed, 36 insertions, 30 deletions

diff --git a/subr.ex/ex_init.subr b/subr.ex/ex_init.subr
index 5d1035ad..3125aadf 100644
--- a/subr.ex/ex_init.subr
+++ b/subr.ex/ex_init.subr
@@ -16,7 +16,7 @@ exp_setrstatus() {
 # @_ruser:		reference to out variable of build user
 # @_name_base:		base name for messages and theme file(s)
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 ex_init_env() {
 	local	_eie_rstatus="${1#\$}" _eie_rhname="${2#\$}" _eie_ruser="${3#\$}"	\
@@ -100,7 +100,7 @@ ex_init_env() {
 # @_optstring:	getopts(1) optstring
 # @...:		command-line arguments as "${@}"
 #
-# Return:	zero (0) on success, non-zero (>0) on failure
+# Returns:	zero (0) on success, non-zero (>0) on failure
 #
 ex_init_getopts() {
 	local	_eig_rstatus="${1#\$}" _eig_fn="${2}" _eig_optstring="${3}"	\
@@ -168,7 +168,7 @@ ex_init_getopts() {
 # @_name_base:	base name for usage screen file
 # @_optstring:	getopts(1) optstring
 #
-# Return:	zero (0) on success, non-zero (>0) on failure
+# Returns:	zero (0) on success, non-zero (>0) on failure
 #
 ex_init_help() {
 	local	_eih_rstatus="${1#\$}" _eih_args_long="${2}"	\
@@ -249,7 +249,7 @@ ex_init_help() {
 # @_prefix_rpm:				absolute pathname to RPM files prefix
 # @_workdir:				absolute pathname to build-specific temporary directory
 #
-# Return:				zero (0) on success, non-zero (>0) on failure
+# Returns:				zero (0) on success, non-zero (>0) on failure
 #
 ex_init_files() {
 	local	_eif_rstatus="${1#\$}" _eif_rclean_builds="${2#\$}" _eif_rdist="${3#\$}"	\
@@ -317,7 +317,7 @@ ex_init_files() {
 # @_rverbose_tags:	reference to inout variable of -V argument value
 # @_verbose:		-[vV] argument value
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 ex_init_logging() {
 	local	_eil_rstatus="${1#\$}" _eil_rverbose_tags="${2#\$}" _eil_verbose="${3}"	\
@@ -386,7 +386,7 @@ ex_init_logging() {
 # @_rstatus:	reference to out variable of status string on failure
 # @_prereqs:	list of prerequisite commands
 #
-# Return:	zero (0) on success, non-zero (>0) on failure
+# Returns:	zero (0) on success, non-zero (>0) on failure
 #
 ex_init_prereqs() {
 	local	_eip_rstatus="${1#\$}" _eip_prereqs="${2}"	\
@@ -414,7 +414,7 @@ ex_init_prereqs() {
 # @_name_base:	base name for theme file(s)
 # @_theme:	theme name
 #
-# Return:	zero (0) on success, non-zero (>0) on failure
+# Returns:	zero (0) on success, non-zero (>0) on failure
 #
 ex_init_theme() {
 	local	_eit_rstatus="${1#\$}" _eit_hname="${2}" _eit_name_base="${3}" _eit_theme="${4}"	\
diff --git a/subr.ex/ex_pkg.subr b/subr.ex/ex_pkg.subr
index dafd6700..1fa0bc6f 100644
--- a/subr.ex/ex_pkg.subr
+++ b/subr.ex/ex_pkg.subr
@@ -12,7 +12,7 @@
 # @_rpkg_names:		reference to in variable of list of package names
 # @_workdir:		pathname to build-specific temporary directory
 #
-# Return:		zero (0) given no outstanding dependencies, non-zero (>0) otherwise
+# Returns:		zero (0) given no outstanding dependencies, non-zero (>0) otherwise
 # Side effects:		${PKG_${_PKG_NAME}_DEPENDS_FULL} may be mutated
 #
 ex_pkg_check_depends() {
@@ -54,7 +54,7 @@ ex_pkg_check_depends() {
 # @_group_names:	build group names
 # @_pkg_name:		single named package
 #
-# Return:		zero (0) on success, non-zero (>0) if package not found, group name on stdout if package was found.
+# Returns:		zero (0) on success, non-zero (>0) if package not found, group name on stdout if package was found.
 #
 ex_pkg_find_package() {
 	local	_epfp_rgroup_name="${1#\$}" _epfp_group_names="${2}" _epfp_pkg_name="${3}"	\
@@ -85,7 +85,7 @@ ex_pkg_find_package() {
 # @_pkg_version:	single package version
 # @_ldefault:		SP-separated list of default value names (any of: patches, patches_pre, vars_file)
 #
-# Return:		zero (0) on success, non-zero (>0) on invalid default value name or unknown package.
+# Returns:		zero (0) on success, non-zero (>0) on invalid default value name or unknown package.
 #
 ex_pkg_get_default() {
 	local	_epgd_rdefault="${1#\$}" _epgd_default_idx="${2}" _epgd_pkg_name="${3}"	\
@@ -141,7 +141,7 @@ ex_pkg_get_default() {
 # @_rpkg_names:	reference to out variable of package names
 # @_group_name:	build group name
 #
-# Return:	zero (0) on success, non-zero (>0) on failure, list of package names on stdout on success.
+# Returns:	zero (0) on success, non-zero (>0) on failure, list of package names on stdout on success.
 #
 ex_pkg_get_packages() {
 	local	_epgp_rpkg_names="${1#\$}" _epgp_group_name="${2}"	\
@@ -163,7 +163,7 @@ ex_pkg_get_packages() {
 # @_rbuild_arch:	in reference to build architecture
 # @_rbuild_kind:	in reference to build kind
 #
-# Return:	zero (0) on success, non-zero (>0) on failure, build variables post-return on success.
+# Returns:	zero (0) on success, non-zero (>0) on failure, build variables post-return on success.
 #
 ex_pkg_load_vars() {
 	local	_eplv_rstatus="${1#\$}" _eplv_rbuild_arch="${2#\$}" _eplv_rbuild_kind="${3#\$}"	\
@@ -213,7 +213,7 @@ ex_pkg_load_vars() {
 # @_rgroup_auto:	reference to in variable of flag controlling whether to build group automatically
 # @_rgroup_target:	reference to in variable of build group targets
 #
-# Return:		zero (0) on success, non-zero (>0) on failure.
+# Returns:		zero (0) on success, non-zero (>0) on failure.
 #
 ex_pkg_load_groups() {
 	local	_eplg_rgroups="${1#\$}" _eplg_rgroups_noauto="${2#\$}"		\
@@ -272,7 +272,7 @@ ex_pkg_load_groups() {
 # @_test_finished:	only exclude disabled packages (0,) split finished packages
 # @_workdir:		pathname to build-specific temporary directory
 #
-# Return:		zero (0) on success, non-zero (>0) on failure.
+# Returns:		zero (0) on success, non-zero (>0) on failure.
 #
 ex_pkg_unfold_depends() {
 	local	_epud_rdisabled="${1#\$}" _epud_rfinished="${2#\$}" _epud_rnames="${3#\$}"	\
@@ -337,7 +337,7 @@ ex_pkg_unfold_depends() {
 # @_test_finished:	only exclude disabled packages (0,) split finished packages
 # @_workdir:		pathname to build-specific temporary directory
 #
-# Return:		zero (0) on success, non-zero (>0) on failure.
+# Returns:		zero (0) on success, non-zero (>0) on failure.
 #
 ex_pkg_unfold_rdepends() {
 	local	_epur_rdisabled="${1#\$}" _epur_rfinished="${2#\$}" _epur_rnames="${3#\$}"	\
diff --git a/subr.ex/ex_pkg_dispatch.subr b/subr.ex/ex_pkg_dispatch.subr
index 98852dab..a80ae21d 100644
--- a/subr.ex/ex_pkg_dispatch.subr
+++ b/subr.ex/ex_pkg_dispatch.subr
@@ -10,7 +10,7 @@
 # @_pkg_disabled:	list of disabled packages
 # @_pkg_finished:	list of finished packages
 #
-# Return:		zero (0) on success, non-zero (>0) on failure.
+# Returns:		zero (0) on success, non-zero (>0) on failure.
 #
 exp_pkg_dispatch_complete() {
 	local	_epdc_dispatch_fn="${1}" _epdc_group_name="${2}" _epdc_pkg_disabled="${3}"	\
@@ -39,7 +39,7 @@ exp_pkg_dispatch_complete() {
 # @_reversefl:		unfold reverse dependencies (1) or dependencies (0)
 # @_workdir:		pathname to build-specific temporary directory
 #
-# Return:		zero (0) on success, non-zero (>0) on failure.
+# Returns:		zero (0) on success, non-zero (>0) on failure.
 #
 exp_pkg_dispatch_expand_packages() {
 	local	_epdep_rdisabled="${1#\$}" _epdep_rfinished="${2#\$}" _epdep_rnames="${3#\$}"	\
@@ -98,7 +98,7 @@ exp_pkg_dispatch_expand_packages() {
 # @_restart_at:			optional comma-separated list of build steps at which to rebuild or ALL or LAST
 # @_workdir:			pathname to build-specific temporary directory
 #
-# Return:			zero (0) on success, non-zero (>0) on failure.
+# Returns:			zero (0) on success, non-zero (>0) on failure.
 #
 exp_pkg_dispatch_group() {
 	local	_epdg_rdispatch_count="${1#\$}" _epdg_rdispatch_count_cur="${2#\$}" _epdg_dispatch_count_max="${3#\$}"	\
@@ -233,7 +233,7 @@ exp_pkg_dispatch_group() {
 # @_restart_at:			optional comma-separated list of build steps at which to rebuild or ALL or LAST
 # @_workdir:			pathname to build-specific temporary directory
 #
-# Return:			zero (0) on success, non-zero (>0) on failure.
+# Returns:			zero (0) on success, non-zero (>0) on failure.
 #
 exp_pkg_dispatch_packages() {
 	local	_epdp2_rdispatch_count="${1#\$}" _epdp2_dispatch_count_cur="${2}" _epdp2_dispatch_count_max="${3}"	\
@@ -292,7 +292,7 @@ exp_pkg_dispatch_packages() {
 # @_restart_recursive:		optional flag specifiying either no dependency expansion (0,) dependency expansion (1,) dependency expansion and forcibly rebuild (2,) forcibly rebuild reverse dependencies (3.)
 # @_workdir:			pathname to build-specific temporary directory
 #
-# Return:			zero (0) on success, non-zero (>0) on failure.
+# Returns:			zero (0) on success, non-zero (>0) on failure.
 #
 ex_pkg_dispatch() {
 	local	_epd_rdispatch_wait="${1#\$}" _epd_build_steps_default="${2}" _epd_build_vars_default="${3}"		\
@@ -389,7 +389,7 @@ ex_pkg_dispatch() {
 # ex_pkg_dipatch_send() - send message from dispatcher child process to dispatcher parent process across FIFO
 # @_op:		message operation string
 #
-# Return:	zero (0) invariably.
+# Returns:	zero (0) invariably.
 #
 ex_pkg_dispatch_send() {
 	local _epds_op="${1}";
diff --git a/subr.ex/ex_pkg_env.subr b/subr.ex/ex_pkg_env.subr
index 2f394e5b..a177f6d2 100644
--- a/subr.ex/ex_pkg_env.subr
+++ b/subr.ex/ex_pkg_env.subr
@@ -9,7 +9,7 @@
 # @_pkg_name:			single package name
 # @_workdir:			pathname to build-specific temporary directory
 #
-# Return:			zero (0) on success, non-zero (>0) on failure
+# Returns:			zero (0) on success, non-zero (>0) on failure
 #
 exp_pkg_env_defaults() {
 	local _epped_build_steps_default="${1}" _epped_pkg_name="${2}" _epped_workdir="${3}";
@@ -65,7 +65,7 @@ exp_pkg_env_defaults() {
 # build group, package to inherit from if any, or package for a single named
 # package, and exports variables optionally named in ${PKG_ENV_VARS_EXTRA}.
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 exp_pkg_env_set() {
 	local	_eppes_build_vars_default="${1}" _eppes_group_name="${2}" _eppes_pkg_name="${3}"	\
@@ -108,7 +108,7 @@ exp_pkg_env_set() {
 # @_restart_at:			optional comma-separated list of build steps at which to rebuild or ALL or LAST
 # @_workdir:			pathname to build-specific temporary directory
 #
-# Return:			zero (0) on success, non-zero (>0) on failure
+# Returns:			zero (0) on success, non-zero (>0) on failure
 #
 ex_pkg_env() {
 	local	_epe_build_steps_default="${1}" _epe_build_vars_default="${2}"		\
@@ -152,7 +152,7 @@ ex_pkg_env() {
 # @_build_step:		build step set status of
 # [@${@}]:		optional list of build steps to invalidate status of
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 ex_pkg_state_set() {
 	rtl_state_set "${BUILD_WORKDIR}" "${@}";
@@ -170,7 +170,7 @@ ex_pkg_state_set2() {
 # @_build_step:		build step to test status of
 # @_restart_at:		optional comma-separated list of build steps at which to rebuild or ALL or LAST
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 ex_pkg_state_test() {
 	rtl_state_test "${BUILD_WORKDIR}" "${@}";
diff --git a/subr.ex/ex_pkg_exec.subr b/subr.ex/ex_pkg_exec.subr
index 08291e45..d64d8159 100644
--- a/subr.ex/ex_pkg_exec.subr
+++ b/subr.ex/ex_pkg_exec.subr
@@ -10,7 +10,7 @@
 # @_restart_at:		optional comma-separated list of build steps at which to rebuild or ALL or LAST
 # @_workdir:		pathname to build-specific temporary directory
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 exp_pkg_exec_pre() {
 	local _eppep_group_name="${1}" _eppep_pkg_name="${2}" _eppep_restart_at="${3}" _eppep_workdir="${4}";
@@ -58,7 +58,7 @@ exp_pkg_exec_pre() {
 # @_restart_at:		optional comma-separated list of build steps at which to rebuild or ALL or LAST
 # @_step:		build step to execute
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 exp_pkg_exec_step() {
 	local	_eppes_group_name="${1}" _eppes_pkg_name="${2}" _eppes_restart_at="${3}"	\
@@ -96,7 +96,7 @@ exp_pkg_exec_step() {
 # @_restart_at:		optional comma-separated list of build steps at which to rebuild or ALL or LAST
 # @_workdir:		pathname to build-specific temporary directory
 #
-# Return:		zero (0) on success, non-zero (>0) on failure
+# Returns:		zero (0) on success, non-zero (>0) on failure
 #
 exp_pkg_exec() {
 	local	_eppe_dispatch_fn="${1}" _eppe_group_name="${2}" _eppe_pkg_name="${3}"	\
@@ -166,7 +166,7 @@ exp_pkg_exec() {
 # @_restart_at:			optional comma-separated list of build steps at which to rebuild or ALL or LAST
 # @_workdir:			pathname to build-specific temporary directory
 #
-# Return:			zero (0) on success, non-zero (>0) on failure.
+# Returns:			zero (0) on success, non-zero (>0) on failure.
 #
 ex_pkg_exec() {
 	local	_epdp_rdispatch_count="${1#\$}" _epdp_dispatch_count_cur="${2}" _epdp_dispatch_count_max="${3}"		\
diff --git a/subr.rtl/rtl_complex.subr b/subr.rtl/rtl_complex.subr
index fd8e6f01..0a475d07 100644
--- a/subr.rtl/rtl_complex.subr
+++ b/subr.rtl/rtl_complex.subr
@@ -3,6 +3,12 @@
 # set +o errexit -o noglob -o nounset is assumed.
 #
 
+#
+# rtl_export_vars() - 
+# @_unsetfl:	
+# 
+# Returns:	zero (0) on success, non-zero (>0) on failure
+#
 rtl_export_vars() {
 	local _rev_unsetfl=0;