From ce796500a66aff1b2c073a890eb4d87c4f87fad1 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Tue, 23 Nov 2021 22:52:47 +0100 Subject: [PATCH] doc: desc completiondir install opts in NEWS/INSTALL --- INSTALL.rst | 31 +++++++++++++++++++++++++++++++ NEWS.rst | 4 ++++ 2 files changed, 35 insertions(+) diff --git a/INSTALL.rst b/INSTALL.rst index 657745bf..a0a720b2 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -655,6 +655,16 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): .. versionadded:: 4.7 +.. instopt:: --with-bashcompletiondir=DIR + + Directory for Bash completion scripts. When this option is not set Bash + completion script for Modules is installed in the initialization script + directory and is sourced from Modules Bash initialization script. (default=) + + .. only:: html + + .. versionadded:: 5.1 + .. instopt:: --with-bin-search-path=PATHLIST List of paths to look at when searching the location of tools required to @@ -716,6 +726,16 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): .. versionadded:: 4.8 +.. instopt:: --with-fishcompletiondir=DIR + + Directory for Fish completion scripts. When this option is not set Fish + completion script for Modules is installed in the initialization script + directory and is sourced from Modules Fish initialization script. (default=) + + .. only:: html + + .. versionadded:: 5.1 + .. instopt:: --with-icase=VALUE Apply a case insensitive match to module specification on :subcmd:`avail`, @@ -986,3 +1006,14 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): .. only:: html .. versionadded:: 4.3 + +.. instopt:: --with-zshcompletiondir=DIR + + Directory for Zsh completion scripts. When this option is not set Zsh + completion script for Modules is installed in the initialization script + directory and :envvar:`FPATH` is set in Zsh initialization script to point to + this location. (default=) + + .. only:: html + + .. versionadded:: 5.1 diff --git a/NEWS.rst b/NEWS.rst index df0441f4..c1354334 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -60,6 +60,10 @@ Modules 5.1.0 (not yet released) * Add the ``--set-if-undef`` option to the :mfcmd:`setenv` modulefile command to set environment variable when modulefile is loaded only this variable is not yet defined. +* Install: add the :instopt:`--with-bashcompletiondir`, + :instopt:`--with-fishcompletiondir` and :instopt:`--with-zshcompletiondir` + installation options to install shell completion scripts in their + system-wide location. (fix issue #428) .. _Code of conduct: https://github.com/cea-hpc/modules/blob/master/CODE_OF_CONDUCT.md