Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Apr 29, 2024
1 parent 2cf76d5 commit 6392749
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 29 deletions.
40 changes: 23 additions & 17 deletions ChangeLog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,36 @@

# ChangeLog

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E13-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 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.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E13-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.13.0
## 0.13.0 (2021-09-04)

* Moved to a new documentation rendering engine.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E12-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.12.1
## 0.12.1 (2021-08-24)

* Added `(declare (ignorable %pop-argument))` to suppress a compiler `NOTE` under `SBCL`.

Thanks to Alessio Stalla!

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E12-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.12.0
## 0.12.0 (2021-06-05)

* Added LispWorks support.
* Program name now evaluated at runtime instead of a compile-time.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E11-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.11.0
## 0.11.0 (2021-05-08)

<a id="backward-incompatible-change"></a>

Expand All @@ -46,7 +52,7 @@ can carry optional keyword arguments, such as

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E10-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.10.0
## 0.10.0 (2021-04-25)

* Moved documentation from reStructured readme to `40ANTS-DOC`
documentation builder.
Expand All @@ -55,15 +61,15 @@ can carry optional keyword arguments, such as

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E9-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.9.1
## 0.9.1 (2021-01-27)

* Fixed work under `ABCL` and probably `CMUCL`.
* Help commands now exit with 0 status code.
* Fixed annoying banner about missing `CC` env variable.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E9-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.9.0
## 0.9.0 (2018-12-07)

* Added support for programs, built with `ASDF:MAKE`.

Expand All @@ -86,28 +92,28 @@ qlot exec ros run -L sbcl -e '(asdf:make :work-hours)'
```
<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E8-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.8.0
## 0.8.0 (2018-10-15)

* Added support for positional arguments.
* Fixed issue of catching signals not inherited `error` and
handling them as errors by printing traceback and quitting.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E7-2E2-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.7.2
## 0.7.2 (2018-07-14)

* Added `Ctrl-C` handling. However seems it does not work for `CCL` :(

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E7-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 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].

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E7-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 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
Expand All @@ -119,26 +125,26 @@ This solves issues in programs which use `(uiop:run-program ...)` or

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E6-2E1-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 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.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E6-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.6.0
## 0.6.0 (2018-06-07)

* Added support for nested commands defined with [`defmain:defcommand`][4b6c] macro.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E5-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 0.5.0
## 0.5.0 (2018-06-02)

* System was made a `package-inferred` and now uses Rove for tests.

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E4-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 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`.
Expand Down Expand Up @@ -170,7 +176,7 @@ Also, you can pass `NIL` as a value to disable short name:

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E3-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 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
Expand All @@ -182,7 +188,7 @@ Also, you can pass `NIL` as a value to disable short name:

<a id="x-28DEFMAIN-2FCHANGELOG-3A-3A-7C0-2E2-2E0-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

## 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
Expand Down
24 changes: 12 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The main entry point for defining the main function for your program is the [`de

<a id="x-28DEFMAIN-3ADEFMAIN-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29"></a>

### [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.

Expand Down Expand Up @@ -173,7 +173,7 @@ to define additional subcommands using [`defcommand`][4b6c] macro:

<a id="x-28DEFMAIN-3ADEFCOMMAND-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29"></a>

#### [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.

Expand Down Expand Up @@ -228,29 +228,29 @@ When writing more complex logic, these helpers could be useful:

<a id="x-28DEFMAIN-3APRINT-HELP-20FUNCTION-29"></a>

#### [function](10b9) `defmain:print-help`
#### [function](439f) `defmain:print-help`

Outputs to stdout a help about command line utility.

<a id="x-28DEFMAIN-3APRINT-COMMANDS-HELP-20FUNCTION-29"></a>

#### [function](1cd9) `defmain:print-commands-help`
#### [function](2e33) `defmain:print-commands-help`

Outputs information about supported subcommands.

It should be called from the function defined with [`defmain`][4130] macro.

<a id="x-28DEFMAIN-3AGET-SUBCOMMAND-NAME-20FUNCTION-29"></a>

#### [function](95b2) `defmain:get-subcommand-name`
#### [function](26b5) `defmain:get-subcommand-name`

Returns a string with current subcommand's name.

It should be called from the function defined with [`defmain`][4130] macro.

<a id="x-28DEFMAIN-3ASUBCOMMAND-20FUNCTION-29"></a>

#### [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.
Expand Down Expand Up @@ -300,12 +300,12 @@ Backtrace for: #<SB-THREAD:THREAD "main thread" RUNNING
[4130]: https://40ants.com/defmain/#x-28DEFMAIN-3ADEFMAIN-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29
[98fc]: https://40ants.com/defmain/#x-28DEFMAIN-3ASUBCOMMAND-20FUNCTION-29
[26c5]: https://github.com/40ants/defmain
[1cd9]: https://github.com/40ants/defmain/blob/109a771b1ab4804d87f7b7259b0b20cd4cecc5e2/src/defmain.lisp#L482
[95b2]: https://github.com/40ants/defmain/blob/109a771b1ab4804d87f7b7259b0b20cd4cecc5e2/src/defmain.lisp#L489
[aa7a]: https://github.com/40ants/defmain/blob/109a771b1ab4804d87f7b7259b0b20cd4cecc5e2/src/defmain.lisp#L496
[134f]: https://github.com/40ants/defmain/blob/109a771b1ab4804d87f7b7259b0b20cd4cecc5e2/src/defmain.lisp#L589
[94c8]: https://github.com/40ants/defmain/blob/109a771b1ab4804d87f7b7259b0b20cd4cecc5e2/src/defmain.lisp#L828
[10b9]: https://github.com/40ants/defmain/blob/109a771b1ab4804d87f7b7259b0b20cd4cecc5e2/src/defmain.lisp#L888
[2e33]: https://github.com/40ants/defmain/blob/2cf76d5c86d8288c64ceab3d62ffe4ce34e4f765/src/defmain.lisp#L482
[26b5]: https://github.com/40ants/defmain/blob/2cf76d5c86d8288c64ceab3d62ffe4ce34e4f765/src/defmain.lisp#L489
[395b]: https://github.com/40ants/defmain/blob/2cf76d5c86d8288c64ceab3d62ffe4ce34e4f765/src/defmain.lisp#L496
[8d34]: https://github.com/40ants/defmain/blob/2cf76d5c86d8288c64ceab3d62ffe4ce34e4f765/src/defmain.lisp#L588
[efa9]: https://github.com/40ants/defmain/blob/2cf76d5c86d8288c64ceab3d62ffe4ce34e4f765/src/defmain.lisp#L827
[439f]: https://github.com/40ants/defmain/blob/2cf76d5c86d8288c64ceab3d62ffe4ce34e4f765/src/defmain.lisp#L887
[defe]: https://github.com/40ants/defmain/issues
[da87]: https://github.com/didierverna/clon
[2c00]: https://quickdocs.org/40ants-doc
Expand Down

0 comments on commit 6392749

Please sign in to comment.