From 7d702f59828e92936edaa654e7854ee492be269d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luc=C3=ADa=20Andrea=20Illanes=20Albornoz?= Date: Thu, 30 Mar 2023 19:29:26 +0200 Subject: subr.ex/*: documentation cleanup. --- subr.ex/ex_init.subr | 24 ++++++++++++------------ subr.ex/ex_pkg.subr | 28 ++++++++++++++-------------- subr.ex/ex_pkg_dispatch.subr | 34 +++++++++++++++++----------------- 3 files changed, 43 insertions(+), 43 deletions(-) diff --git a/subr.ex/ex_init.subr b/subr.ex/ex_init.subr index 61d2676f..62b01305 100644 --- a/subr.ex/ex_init.subr +++ b/subr.ex/ex_init.subr @@ -11,9 +11,9 @@ exp_setrstatus() { # # ex_init_env() - initialise build environment -# @_rstatus: reference to out variable of status string on failure -# @_rhname: reference to out variable of build hostname -# @_ruser: reference to out variable of build user +# @_rstatus: out reference to variable of status string on failure +# @_rhname: out reference to variable of build hostname +# @_ruser: out reference to variable of build user # @_name_base: base name for messages and theme file(s) # # Returns: zero (0) on success, non-zero (>0) on failure @@ -95,7 +95,7 @@ ex_init_env() { # # ex_init_getopts() - process command-line arguments -# @_rstatus: reference to out variable of status string on failure +# @_rstatus: out reference to variable of status string on failure # @_fn: reference to function called to process command-line argument # @_optstring: getopts(1) optstring # @...: command-line arguments as "${@}" @@ -163,7 +163,7 @@ ex_init_getopts() { # # ex_init_help() - display usage screen and exit if requested in command-line arguments -# @_rstatus: reference to out variable of status string on failure +# @_rstatus: out reference to variable of status string on failure # @_args_long: optional list of long (prefixed with `--') arguments # @_name_base: base name for usage screen file # @_optstring: getopts(1) optstring @@ -235,9 +235,9 @@ ex_init_help() { # # ex_init_files() - initialise build files -# @_rstatus: reference to out variable of status string on failure -# @_rclean_builds: reference to in variable of -C argument value -# @_rdist: reference to in variable of -D argument value +# @_rstatus: out reference to variable of status string on failure +# @_rclean_builds: in reference to variable of -C argument value +# @_rdist: in reference to variable of -D argument value # @_build_log_fname: absolute pathname to build log file # @_build_log_last_fname: absolute pathname to last build log file # @_build_status_in_progress_fname: absolute pathname to build-in-progress status file @@ -318,8 +318,8 @@ ex_init_files() { # # ex_init_logging() - initialise build logging -# @_rstatus: reference to out variable of status string on failure -# @_rverbose_tags: reference to inout variable of -V argument value +# @_rstatus: out reference to variable of status string on failure +# @_rverbose_tags: in reference toout variable of -V argument value # @_verbose: -[vV] argument value # # Returns: zero (0) on success, non-zero (>0) on failure @@ -388,7 +388,7 @@ ex_init_logging() { # # ex_init_prereqs() - initialise build prerequisite commands -# @_rstatus: reference to out variable of status string on failure +# @_rstatus: out reference to variable of status string on failure # @_prereqs: list of prerequisite commands # # Returns: zero (0) on success, non-zero (>0) on failure @@ -414,7 +414,7 @@ ex_init_prereqs() { # # ex_init_theme() - initialise theme -# @_rstatus: reference to out variable of status string on failure +# @_rstatus: out reference to variable of status string on failure # @_hname: build hostname # @_name_base: base name for theme file(s) # @_theme: theme name diff --git a/subr.ex/ex_pkg.subr b/subr.ex/ex_pkg.subr index c064b408..8230cf79 100644 --- a/subr.ex/ex_pkg.subr +++ b/subr.ex/ex_pkg.subr @@ -6,10 +6,10 @@ # # ex_pkg_check_depends() - check single named package for unsatisfied dependencies # @_checkfl: enable (1) or inhibit (0) dependency expansion -# @_rpkg_disabled: reference to in variable of list of disabled packages -# @_rpkg_finished: reference to in variable of list of finished packages +# @_rpkg_disabled: in reference to variable of list of disabled packages +# @_rpkg_finished: in reference to variable of list of finished packages # @_pkg_name: single package name -# @_rpkg_names: reference to in variable of list of package names +# @_rpkg_names: in reference to variable of list of package names # @_workdir: pathname to build-specific temporary directory # # Returns: zero (0) given no outstanding dependencies, non-zero (>0) otherwise @@ -50,7 +50,7 @@ ex_pkg_check_depends() { # # ex_pkg_find_package() - find build group a single named package belongs to -# @_rgroup_name: reference to out variable of build group name +# @_rgroup_name: out reference to variable of build group name # @_group_names: build group names # @_pkg_name: single named package # @@ -79,7 +79,7 @@ ex_pkg_find_package() { # # ex_pkg_get_default() - get single package default value -# @_rdefault: reference to out variable of default value or "" on end of list +# @_rdefault: out reference to variable of default value or "" on end of list # @_default_idx: one-based single default value index # @_pkg_name: single package name # @_pkg_version: single package version @@ -138,7 +138,7 @@ ex_pkg_get_default() { # # ex_pkg_get_packages() - get list of packages belonging to single named build group -# @_rpkg_names: reference to out variable of package names +# @_rpkg_names: out reference to variable of package names # @_group_name: build group name # # Returns: zero (0) on success, non-zero (>0) on failure, list of package names on stdout on success. @@ -231,8 +231,8 @@ ex_pkg_load_vars() { # # ex_pkg_load_groups() - load all available build groups -# @_rgroups: reference to out variable of build groups -# @_rgroups_noauoto: optional reference to out variable of build groups not built automatically +# @_rgroups: out reference to variable of build groups +# @_rgroups_noauoto: optional out reference to variable of build groups not built automatically # # Returns: zero (0) on success, non-zero (>0) on failure. # @@ -305,9 +305,9 @@ ex_pkg_load_groups() { # # ex_pkg_unfold_depends() - unfold list of package names into dependency-expanded set of complete, disabled, finished, and outstanding package names -# @_rdisabled: reference to inout variable of disabled packages -# @_rfinished: reference to inout variable of finished packages -# @_rnames: reference to out variable of package names +# @_rdisabled: in reference toout variable of disabled packages +# @_rfinished: in reference toout variable of finished packages +# @_rnames: out reference to variable of package names # @_checkfl: enable (1) or inhibit (0) dependency expansion # @_forcefl: enable (1) or inhibit (0) forcibly rebuilding finished packages # @_group_name: build group name @@ -372,9 +372,9 @@ ex_pkg_unfold_depends() { # # ex_pkg_unfold_rdepends() - unfold list of package names into reverse dependency-expanded set of complete, disabled, finished, and outstanding package names -# @_rdisabled: reference to inout variable of disabled packages -# @_rfinished: reference to inout variable of finished packages -# @_rnames: reference to out variable of package names +# @_rdisabled: in reference toout variable of disabled packages +# @_rfinished: in reference toout variable of finished packages +# @_rnames: out reference to variable of package names # @_group_name: build group name # @_pkg_names: list of package names # @_restart: optional whitespace-separated list of package names to rebuild diff --git a/subr.ex/ex_pkg_dispatch.subr b/subr.ex/ex_pkg_dispatch.subr index 22917baa..5a5ef006 100644 --- a/subr.ex/ex_pkg_dispatch.subr +++ b/subr.ex/ex_pkg_dispatch.subr @@ -29,9 +29,9 @@ exp_pkg_dispatch_complete() { # # exp_pkg_dispatch_expand_packages() - expand build group name to list of packages ordered and filtered according to dependency and restart constraints -# @_rdisabled: reference to out variable of disabled packages -# @_rfinished: reference to out variable of finished packages -# @_rnames: reference to out variable of package names +# @_rdisabled: out reference to variable of disabled packages +# @_rfinished: out reference to variable of finished packages +# @_rnames: out reference to variable of package names # @_checkfl: enable (1) or inhibit (0) dependency expansion # @_forcefl: enable (1) or inhibit (0) forcibly rebuilding finished packages # @_group_name: build group name @@ -77,16 +77,16 @@ exp_pkg_dispatch_expand_packages() { # # exp_pkg_dispatch_group() - dispatch a single build group -# @_rdispatch_count: reference to inout variable of dispatcher count -# @_rdispatch_count_cur: reference to inout variable of current dispatcher count +# @_rdispatch_count: in reference toout variable of dispatcher count +# @_rdispatch_count_cur: in reference toout variable of current dispatcher count # @_dispatch_count_max: maximum dispatcher count # @_dispatch_group_cur: current group # @_dispatch_group_max: maximum group -# @_rdispatch_njobs: reference to inout variable of dispatcher count -# @_rdispatch_wait: reference to inout variable of package names in a wait state -# @_rpkg_disabled: reference to in variable of list of disabled packages -# @_rpkg_finished: reference to inout variable of list of finished packages -# @_rpkg_names: reference to inout variable of list of package names +# @_rdispatch_njobs: in reference toout variable of dispatcher count +# @_rdispatch_wait: in reference toout variable of package names in a wait state +# @_rpkg_disabled: in reference to variable of list of disabled packages +# @_rpkg_finished: in reference toout variable of list of finished packages +# @_rpkg_names: in reference toout variable of list of package names # @_build_steps_default: list of default build steps # @_build_vars_default: list of default build variables # @_checkfl: enable (1) or inhibit (0) dependency expansion @@ -213,16 +213,16 @@ exp_pkg_dispatch_group() { # # exp_pkg_dispatch_packages() - dispatch set of packages -# @_rdispatch_count: reference to inout variable of dispatcher count +# @_rdispatch_count: in reference toout variable of dispatcher count # @_dispatch_count_cur: current dispatcher count # @_dispatch_count_max: maximum dispatcher count # @_dispatch_group_cur: current group # @_dispatch_group_max: maximum group -# @_rdispatch_njobs: reference to inout variable of dispatcher count -# @_rdispatch_wait: reference to inout variable of package names in a wait state -# @_rpkg_disabled: reference to in variable of list of disabled packages -# @_rpkg_finished: reference to inout variable of list of finished packages -# @_rpkg_names: reference to inout variable of list of package names +# @_rdispatch_njobs: in reference toout variable of dispatcher count +# @_rdispatch_wait: in reference toout variable of package names in a wait state +# @_rpkg_disabled: in reference to variable of list of disabled packages +# @_rpkg_finished: in reference toout variable of list of finished packages +# @_rpkg_names: in reference toout variable of list of package names # @_build_steps_default: list of default build steps # @_build_vars_default: list of default build variables # @_checkfl: enable (1) or inhibit (0) dependency expansion @@ -278,7 +278,7 @@ exp_pkg_dispatch_packages() { # # ex_pkg_dispatch() - dispatch a set of build group -# @_rdispatch_wait: reference to out variable of package names in a wait state +# @_rdispatch_wait: out reference to variable of package names in a wait state # @_build_steps_default: list of default build steps # @_build_vars_default: list of default build variables # @_continue_on_failfl: continue on failed package build (1) or break (0) -- cgit v1.2.3