Add short form option '-p' for '--paginate'

Fixes #593

Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>

Author: xdelaruelle

NEWS.rst

@@ -54,6 +54,8 @@ Modules 5.7.0 (not yet released)
   :instopt:`--disable-compressed-changelog<--enable-compressed-changelog>` to
   cope with packaging process handling documentation file compression at their
   level. (fix issue #592)
+* Add :option:`-p` option as an abbreviated form for :option:`--paginate`.
+  (fix issue #593)
 
 
 .. _5.6 release notes:

doc/source/changes.rst

@@ -845,6 +845,8 @@ The following command line switches appeared on Modules 5.
 +------------+-----------------------------------------------------------------+
 | 5.6        | :option:`--dumpname`                                            |
 +------------+-----------------------------------------------------------------+
+| 5.7        | :option:`-p`                                                    |
++------------+-----------------------------------------------------------------+
 
 :option:`--output`
 

doc/source/module.rst

@@ -541,7 +541,7 @@ switches are accepted:
        Elements *provided-alias* and *via* added for :subcmd:`avail` and
        :subcmd:`spider` sub-commands
 
-.. option:: --paginate
+.. option:: --paginate, -p
 
  Pipe all message output into :command:`less` (or if set, to the command
  referred in :envvar:`MODULES_PAGER` variable) if error output stream is a
@@ -551,6 +551,9 @@ switches are accepted:
 
     .. versionadded:: 4.1
 
+    .. versionchanged:: 5.7
+       Short form option :option:`-p` added
+
 .. option:: --redirect
 
  Send message output to stdout instead of stderr. Only supported on sh, bash,

init/Makefile

@@ -120,7 +120,7 @@ endif
 # define variables for shell completion
 comp_cmds := add add-any apropos aliases avail append-path cachebuild cacheclear clear config del describe disable display edit help initadd initclear initlist initprepend initrm is-loaded is-saved is-used is-avail info-loaded keyword lint list load load-any mod-to-sh path paths purge prepend-path refresh reload reset restore rm remove remove-path save savelist saveshow saverm search show sh-to-mod source spider stash stashclear stashlist stashpop stashrm stashshow state swap switch test try-add try-load unload unuse update use whatis
 comp_long_opts := --debug --dumpname --help --silent --trace --verbose --version --paginate --no-pager --color --color= --width --width= --ignore-cache --ignore-user-rc
-comp_opts := -D -h -s -T -v -V -w $(comp_long_opts)
+comp_opts := -D -h -s -T -v -V -p -w $(comp_long_opts)
 comp_load_opts := --auto --no-auto --force -f --icase -i --tag --tag=
 comp_unload_opts := --auto --no-auto --force -f --icase -i
 comp_list_opts := -a -j -l -o -t --all --json --long --output --output= --terse

init/fish_completion

@@ -170,7 +170,7 @@ complete -c module -s S -l starts-with --description 'Search modules whose name
 complete -c module -s C -l contains --description 'Search modules whose name contains query string'
 complete -c module -l indepth --description 'Perform recursive avail search'
 complete -c module -l no-indepth --description 'Perform non-recursive avail search'
-complete -c module -l paginate --description 'Pipe mesg output into a pager if stream attached to terminal'
+complete -c module -s p -l paginate --description 'Pipe mesg output into a pager if stream attached to terminal'
 complete -c module -l no-pager --description 'Do not pipe message output into a pager'
 complete -c module -l auto --description 'Enable automated module handling mode'
 complete -c module -l no-auto --description 'Disable automated module handling mode'

init/zsh-functions/_module.in

@@ -129,7 +129,7 @@ _module() {
       '(-V --version)'{-V,--version}'[Module version]' \
       '--dumpname[Module implementation name]' \
       '(-w --width=)'{-w,--width=}'[Set output width]' \
-      '--paginate[Pipe mesg output into a pager if stream attached to terminal]' \
+      '(-p --paginate)'{-p,--paginate}'[Pipe mesg output into a pager if stream attached to terminal]' \
       '--no-pager[Do not pipe message output into a pager]' \
       '(--color --color=)'{--color,--color=}'[Colorize the output]' \
       '--ignore-cache[Ignore module cache]' \

tcl/main.tcl.in

@@ -702,7 +702,7 @@ if {[catch {
             --dumpname {
                set show_name 1
             }
-            --paginate {
+            -p - --paginate {
                set asked_paginate 1
             }
             --no-pager {

tcl/report.tcl.in

@@ -2169,7 +2169,7 @@ Options:
   -v | --verbose  Enable verbose messages
   -s | --silent   Turn off error, warning and informational messages
   --timer         Report execution times
-  --paginate      Pipe mesg output into a pager if stream attached to terminal
+  -p | --paginate Pipe mesg output into a pager if stream attached to terminal
   --no-pager      Do not pipe message output into a pager
   --redirect      Send output to stdout (only for sh, bash, ksh, zsh and fish)
   --no-redirect   Send output to stderr

testsuite/modules.00-init/100-pager.exp

@@ -121,7 +121,7 @@ if {$verbose} {
 }
 set env(LESS) $opts
 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
-pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
+pager_test_case "-p" $pager_dfl_use "1" $install_pager $install_pageropts
 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
 
 set opts ""
@@ -156,7 +156,7 @@ if {$verbose} {
 }
 set env(PAGER) $cmd
 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
-pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
+pager_test_case "-p" $pager_dfl_use "1" $install_pager $install_pageropts
 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
 
 set cmd "cat"
@@ -183,7 +183,7 @@ if {$verbose} {
 }
 set env(PAGER) $cmd
 pager_test_case "" $pager_dfl_use "-" $install_pager $install_pageropts
-pager_test_case "--paginate" $pager_dfl_use "1" $install_pager $install_pageropts
+pager_test_case "-p" $pager_dfl_use "1" $install_pager $install_pageropts
 pager_test_case "--no-pager" 0 "0" $install_pager $install_pageropts
 
 set cmd "/usr/bin/less"
@@ -232,7 +232,7 @@ if {$verbose} {
 }
 set env(MODULES_PAGER) $cmd
 pager_test_case "" 0 "-" $cmd ""
-pager_test_case "--paginate" 0 "1" $cmd ""
+pager_test_case "-p" 0 "1" $cmd ""
 pager_test_case "--no-pager" 0 "0" $cmd ""
 
 set cmd "cat"
@@ -259,7 +259,7 @@ if {$verbose} {
 }
 unset env(PAGER)
 pager_test_case "" 1 "-" $cmd $opts
-pager_test_case "--paginate" 1 "1" $cmd $opts
+pager_test_case "-p" 1 "1" $cmd $opts
 pager_test_case "--no-pager" 0 "0" $cmd $opts
 
 if {$verbose} {
@@ -279,7 +279,7 @@ if {$verbose} {
 }
 set env(MODULES_PAGER) $cmd
 pager_test_case "" 1 "-" $cmd $opts
-pager_test_case "--paginate" 1 "1" $cmd $opts
+pager_test_case "-p" 1 "1" $cmd $opts
 pager_test_case "--no-pager" 0 "0" $cmd $opts
 
 

testsuite/modules.10-use/031-append.exp

@@ -92,6 +92,12 @@ testouterr_cmd "sh" "$use \$TESTSUITEDIR/modulefiles.2" $ans {}
 setenv_path_var MODULEPATH $modpath
 
 
+# test overriding options
+set ans [list]
+lappend ans [list set MODULEPATH $modpath:$path]
+testouterr_cmd sh "use -p -a $path" $ans {}
+
+
 #
 # Cleanup
 #