Files
modules/doc
Xavier Delaruelle 20093d7218 Introduce 'test' command and mode
Add 'module test' command to trigger when called execution of a
ModulesTest procedure in target modulefile following same kind of
mechanism than 'module help'.

If ModulesTest procedure is missing from modulefile, a 'Unable to find
ModulesTest proc' message is displayed but no error code is set. If
ModulesTest procedure returns 1 (true), test is considered successful and
message 'Test result: PASS' is displayed. If ModulesTest returns no or
any other value, test is considered failed and message 'Test result:
FAIL' is displayed. In this case, module command exit in error.

Adapt bash and tcsh completion scripts for the new command. Describe new
command and new mode in docs.

Adapt existing non-regression tests and relative test modulefiles for
new command and new mode in 00-init, 50-cmds and 70-maint suites. Add
085-test tests in 70-maint to check coherent behavior of new command.
2017-04-30 19:00:18 +02:00
..
2017-04-30 19:00:18 +02:00
2017-04-18 06:15:53 +02:00

This file briefly describes the documentation provided here.

readme.txt  This file.

example.txt There are lots of things you need to plan out
            for a fully functional modules environment.
            This document explains some of those details.

source/     Location of the source files used to create
            html and man documentation for modules.
            If you edit these files run make doc to
            rebuild the man and html files.

man/        Location of the man pages generated by make doc
html/       Location of the html pages generated by make doc

howto/      Location of How-to PDF files
paper/      Location of conference paper PDF files
talk/       Location of presentation support PDF files

emacs.txt    Hints for using modules with emacs lisp.