From 4c7a810284ad379224148fdd96708b263eb8e0e4 Mon Sep 17 00:00:00 2001 From: Achim Gsell Date: Wed, 13 Dec 2023 09:35:58 +0100 Subject: [PATCH] CHANGELOG.md reformatted --- CHANGELOG.md | 160 ++++++++++++++++++++++++++++----------------------- 1 file changed, 87 insertions(+), 73 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bdc5975..bc8c1f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -141,92 +141,106 @@ * The bootstrap script requires Bash 5.0 or newer now. * Bugfix: in the `Pmodules` modulefile force the sourcing of the shell init script while in mode `load` only. +--- ## Version 1.1.9 -* **modulecmd** - * *User visible changes* - * Overlay info added to output of sub-command `search`. - * Output of `module search --verbose` revised for better readability. - * *Internal changes and fixes* - * The shell`s init file is sourced, when Pmodules is loaded as module. - This is required if there are changes in the module function or too - define new shell functions. - * A bug in `libmodules.tcl:module-addgroup()` which crashed - `module load ...` has been fixed. - * In versions before 1.1.9 a colon at the beginning or end of `MODULEPATH` - crashed the module function. This has been fixed. +### **modulecmd** +**User visible changes** +* Overlay info added to output of sub-command `search`. +* Output of `module search --verbose` revised for better readability. -* **build-system** - * *User visible changes* - * The command `modbuild` is now defined as shell function analog to - the `module` command. The main reason to introduce this function - is due to the fact that Bash version 5 or newer is now required - by `modbuild`. The function `modbuild` load Bash 5.x as module - before calling the modbuild-script. If you want to use the script - directly, a Bash binary with version 5.x must be in PATH. - * If a build-script is in the current working directory, - `modbuild` can now be called without specifying the build-script. - * In case of an error in a build-step the build process did not - abort as it should. This has been fixed. - * The option `--overlay` can now be used - - to define an overlay if legacy variants files are used - - to override the overlay in a YAML variants file. - * The new keyword `with` has been introduced in YAML variants file - to specified hierarchical dependencies. - * The function `pbuild::supported_os` has been - removed. `pbuild::supported_systems` provides the same - functionality for legacy configuration files. In YAML module - configuration files `systems` have to be used. +**Internal changes and fixes** +* The shell`s init file is sourced, when Pmodules is loaded as module. + This is required if there are changes in the module function or too + define new shell functions. +* A bug in `libmodules.tcl:module-addgroup()` which crashed + `module load ...` has been fixed. +* In versions before 1.1.9 a colon at the beginning or end of `MODULEPATH` + crashed the module function. This has been fixed. -* **Internal changes and fixes** - * bugfix in setting `PATH` - * requires bash 5 or later +### **build-system** +**User visible changes** +* The command `modbuild` is now defined as shell function analog to + the `module` command. The main reason to introduce this function + is due to the fact that Bash version 5 or newer is now required + by `modbuild`. The function `modbuild` load Bash 5.x as module + before calling the modbuild-script. If you want to use the script + directly, a Bash binary with version 5.x must be in PATH. +* If a build-script is in the current working directory, + `modbuild` can now be called without specifying the build-script. +* In case of an error in a build-step the build process did not + abort as it should. This has been fixed. +* The option `--overlay` can now be used + - to define an overlay if legacy variants files are used + - to override the overlay in a YAML variants file. +* The new keyword `with` has been introduced in YAML variants file + to specified hierarchical dependencies. +* The function `pbuild::supported_os` has been + removed. `pbuild::supported_systems` provides the same + functionality for legacy configuration files. In YAML module + configuration files `systems` have to be used. + +**Internal changes and fixes** +* bugfix in setting `PATH` +* requires bash 5 or later +--- ## Version 1.1.8 -* **modulecmd** - * *User visible changes* - * configuration in YAML files - * modulefiles and software must not - have a common root directory - * the installation root must be specified, it doesn`t default - to the base 'overlay' any more. - * zsh initialisation fixed. - * *Internal changes and fixes* - * std::upvar() replaced with reference variables in part of the - code. - * environment variable `PMODULES_ROOT` removed. - * unsetting aliases fixed. - * update to bash 5.1.16 - * update to findutils 4.9 (macOS only) - * minor fixes -* **build-system** - * *User visible changes* - * YAML format for variants files - * *Internal changes and fixes* - * use lib `libpmodules.bash` - * bugfixes -* **modmanage** - * *User visible changes* - * none, support for overlays still missing - * *Internal changes and fixes* - * none +### **modulecmd** +**User visible changes* +* configuration in YAML files +* modulefiles and software must not + have a common root directory +* the installation root must be specified, it doesn`t default + to the base 'overlay' any more. +* zsh initialisation fixed. + +**Internal changes and fixes** +* std::upvar() replaced with reference variables in part of the + code. +* environment variable `PMODULES_ROOT` removed. +* unsetting aliases fixed. +* update to bash 5.1.16 +* update to findutils 4.9 (macOS only) +* minor fixes + +### **build-system** +**User visible changes** +* YAML format for variants files + +**Internal changes and fixes** +* use lib `libpmodules.bash` +* bugfixes + +### **modmanage** +**User visible changes** +* none, support for overlays still missing + +**Internal changes and fixes** +* none +--- ## Version 1.1.7 -* **modulecmd** - * list of available overlays in subcommand `use` is now better readable -* **buid-system** - * overlay definition must now be in YAML format - * support for YAML formatted variant files (the legacy format - is still supported) - * build-system in 1.1.6 was still work in progress and broken +### **modulecmd** +* list of available overlays in subcommand `use` is now better readable + +### **buid-system** +* overlay definition must now be in YAML format +* support for YAML formatted variant files (the legacy format + is still supported) +* build-system in 1.1.6 was still work in progress and broken +--- ## Version 1.1.6 -* **modulecmd** - * bugfix in searching/loading modules in a hierarchical - group +### **modulecmd** +* bugfix in searching/loading modules in a hierarchical + group +--- ## Version 1.1.5 +### **modulecmd** * first public version with the overlay feature +--- ## Version 1.0.0rc11 * **modulecmd**