jutty/tori
1
1
Fork 0
Code Issues Pull requests Releases 1 Activity

Fix some docs typos, wording and links

Browse source
This commit is contained in:
Juno Takano 2024-06-30 19:06:24 -03:00
parent 87e1687831
commit e0930075a6
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/user-packages.md
View file

@ -7,4 +7,4 @@ The `packages` file is located at the root of the configuration directory and co
When processing the package list, `tori` will compare the list of installed packages to the list in the configuration and ask the user for what action to take in order to conciliate them, unless a default action has been specified. When processing the package list, `tori` will compare the list of installed packages to the list in the configuration and ask the user for what action to take in order to conciliate them, unless a default action has been specified.
For information on how the application determines differences between the configuration package list and the actually installed packages, see [`check`](check). For information on how the application determines differences between the configuration package list and installed packages, see [`check`](./check.md).

6
docs/utilities.md
View file

@ -7,12 +7,12 @@ The two utility functions presently implemented are:
## `log` ## `log`
This utilitiy takes a log level as its first argument and a message as its second argument. The log message must be wrapped in double quotes, otherwise only the first world will be considered part of the message and the rest will be discarded. This utility takes a log level as its first argument and a message as its second argument. The log message must be wrapped in double quotes, otherwise only the first word will be considered part of the message and the rest will be discarded.
The current log levels are: The current log levels are:
- `debug`: Displays only when `DEBUG` is set in the environment. The value `DEBUG` is set to does not matter. To disable the log messages, unset `DEBUG`, for example, with `export DEBUG=` or 'unset DEBUG` - `debug`: Displays only when `DEBUG` is set in the environment with a nanosecond-precision timestamp. The value `DEBUG` is set to does not matter. To disable the log messages, unset `DEBUG`, for example, with `export DEBUG=` or `unset DEBUG`
- `user`: Always displays, with `[tori]` at the very left followed by a second-precision timestamp, a colon and the message - `user`: Always displays, with `[tori]` at the very left followed by a second-precision timestamp, a colon and the message
- `fatal`: Always displays, exactly as `user` - `fatal`: Always displays, exactly as in the `user` level
For now, all log messages are printed to `STDERR` so as not to shadow function return values. For now, all log messages are printed to `STDERR` so as not to shadow function return values.