From 6392749141c0107785c11cda113ec53f29db4ee3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 29 Apr 2024 12:54:58 +0000 Subject: [PATCH] Update docs --- ChangeLog.md | 40 +++++++++++++++++++++++----------------- README.md | 24 ++++++++++++------------ 2 files changed, 35 insertions(+), 29 deletions(-) diff --git a/ChangeLog.md b/ChangeLog.md index 0d41733..9c3c156 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -2,15 +2,21 @@ # ChangeLog + + +## 0.13.1 (2024-04-29) + +* Removed unnecessary text "Here is a list of all supported commands" from the help message of a command having subcommands. + -## 0.13.0 +## 0.13.0 (2021-09-04) * Moved to a new documentation rendering engine. -## 0.12.1 +## 0.12.1 (2021-08-24) * Added `(declare (ignorable %pop-argument))` to suppress a compiler `NOTE` under `SBCL`. @@ -18,14 +24,14 @@ Thanks to Alessio Stalla! -## 0.12.0 +## 0.12.0 (2021-06-05) * Added LispWorks support. * Program name now evaluated at runtime instead of a compile-time. -## 0.11.0 +## 0.11.0 (2021-05-08) @@ -46,7 +52,7 @@ can carry optional keyword arguments, such as -## 0.10.0 +## 0.10.0 (2021-04-25) * Moved documentation from reStructured readme to `40ANTS-DOC` documentation builder. @@ -55,7 +61,7 @@ can carry optional keyword arguments, such as -## 0.9.1 +## 0.9.1 (2021-01-27) * Fixed work under `ABCL` and probably `CMUCL`. * Help commands now exit with 0 status code. @@ -63,7 +69,7 @@ can carry optional keyword arguments, such as -## 0.9.0 +## 0.9.0 (2018-12-07) * Added support for programs, built with `ASDF:MAKE`. @@ -86,7 +92,7 @@ qlot exec ros run -L sbcl -e '(asdf:make :work-hours)' ``` -## 0.8.0 +## 0.8.0 (2018-10-15) * Added support for positional arguments. * Fixed issue of catching signals not inherited `error` and @@ -94,20 +100,20 @@ qlot exec ros run -L sbcl -e '(asdf:make :work-hours)' -## 0.7.2 +## 0.7.2 (2018-07-14) * Added `Ctrl-C` handling. However seems it does not work for `CCL` :( -## 0.7.1 +## 0.7.1 (2018-06-15) Error `Undeclared free variable DEFMAIN/DEFMAIN:HELP-COMMANDS` was fixed for cases where there is no [`defmain:defcommand`][4b6c] calls beside [`defmain:defmain`][4130]. -## 0.7.0 +## 0.7.0 (2018-06-13) Defmain macro now restores temporary pathnames inside of `cl-fad` and `uiop` packages by setting `logical-pathname-translations` for @@ -119,26 +125,26 @@ This solves issues in programs which use `(uiop:run-program ...)` or -## 0.6.1 +## 0.6.1 (2018-06-08) * Now function [`defmain:get-subcommand-name`][86bc] is available in the main function if your specified `&SUBCOMMAND` as it's argument. -## 0.6.0 +## 0.6.0 (2018-06-07) * Added support for nested commands defined with [`defmain:defcommand`][4b6c] macro. -## 0.5.0 +## 0.5.0 (2018-06-02) * System was made a `package-inferred` and now uses Rove for tests. -## 0.4.0 +## 0.4.0 (2018-05-18) * Now [`defmain:defmain`][4130] handles all unhandled conditions, prints a backtrace and program exists with error code `1`. @@ -170,7 +176,7 @@ Also, you can pass `NIL` as a value to disable short name: -## 0.3.0 +## 0.3.0 (2018-05-12) * Fixed a way how `--help` option is processed. Now, this argument can be redefined by user, for example, to give this option another @@ -182,7 +188,7 @@ Also, you can pass `NIL` as a value to disable short name: -## 0.2.0 +## 0.2.0 (2018-02-09) * Added function [`defmain:print-help`][9b39]. * Fixed handling of existing `help` option. Now you can redefine it diff --git a/README.md b/README.md index 8027a0e..0e7a9aa 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ The main entry point for defining the main function for your program is the [`de -### [macro](134f) `defmain:defmain` (name &key program-name) (&rest args) &body body +### [macro](8d34) `defmain:defmain` (name &key program-name) (&rest args) &body body This macro let you to define a main function for a command-line program. @@ -173,7 +173,7 @@ to define additional subcommands using [`defcommand`][4b6c] macro: -#### [macro](94c8) `defmain:defcommand` (parent name) (&rest args) &body body +#### [macro](efa9) `defmain:defcommand` (parent name) (&rest args) &body body This macro is similar to [`defmain`][4130] macro in terms of arguments and body processing. @@ -228,13 +228,13 @@ When writing more complex logic, these helpers could be useful: -#### [function](10b9) `defmain:print-help` +#### [function](439f) `defmain:print-help` Outputs to stdout a help about command line utility. -#### [function](1cd9) `defmain:print-commands-help` +#### [function](2e33) `defmain:print-commands-help` Outputs information about supported subcommands. @@ -242,7 +242,7 @@ It should be called from the function defined with [`defmain`][4130] macro. -#### [function](95b2) `defmain:get-subcommand-name` +#### [function](26b5) `defmain:get-subcommand-name` Returns a string with current subcommand's name. @@ -250,7 +250,7 @@ It should be called from the function defined with [`defmain`][4130] macro. -#### [function](aa7a) `defmain:subcommand` +#### [function](395b) `defmain:subcommand` Executes the current subcommand. It is called automatically at the end of the main body unless you call it manually. @@ -300,12 +300,12 @@ Backtrace for: #