From e0930075a68c9d9369b7459912d485e18a9ef49a Mon Sep 17 00:00:00 2001 From: jutty Date: Sun, 30 Jun 2024 19:06:24 -0300 Subject: [PATCH] Fix some docs typos, wording and links --- docs/user-packages.md | 2 +- docs/utilities.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user-packages.md b/docs/user-packages.md index 4ed7af5..ba121e8 100644 --- a/docs/user-packages.md +++ b/docs/user-packages.md @@ -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. -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). diff --git a/docs/utilities.md b/docs/utilities.md index 3f5d11c..11cb17f 100644 --- a/docs/utilities.md +++ b/docs/utilities.md @@ -7,12 +7,12 @@ The two utility functions presently implemented are: ## `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: -- `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 -- `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.