From d3b48f66b335358b5cee328e7b258d2138adaafc Mon Sep 17 00:00:00 2001 From: jutty Date: Sun, 30 Jun 2024 19:29:23 -0300 Subject: [PATCH] Minor documentation fixes and rewordings --- docs/check.md | 8 ++++---- docs/utilities.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/check.md b/docs/check.md index 23e5f7d..69b24d7 100644 --- a/docs/check.md +++ b/docs/check.md @@ -1,15 +1,15 @@ The `check` option performs two tasks through the configuration processing functions available at `src/configuration.sh` -1. Traverse the configuration directory to assemble a file list containing full paths for both the `base` and `bkp` directories -2. Compare the installed packages with the `packages` file at the root of the configuration directory +1. Traversing the configuration directory to assemble a file list containing full paths for both the `base` and `bkp` directories +2. Comparing the installed packages with the `packages` file at the root of the configuration directory The first task is currently accomplished by resorting to `find`. While this allows for cleaner code, it relies on a utility with variable behavior across operating systems. Given the simplicity of the query, a better option might be using a POSIX-compliant wildcard such as `.[!.]* ..?* *` to match the files directly (e.g., in a for loop). Another option that may provide both readability and portability is repeating the match, once for hidden file and once for non-hidden files. -The second task is accomplished by resorting to the package management functions available at `src/package.sh`. The `package_manager` function abstracts the actualy package manager provided by the underlying system and provides an OS-independent way to query the current manually installed packages. +The second task is accomplished by resorting to the package management functions available at `src/package.sh`. The `package_manager` function abstracts the actual package manager in the underlying system and provides an OS-independent way to query manually installed packages. Through the parsed `packages` configuration file at the root of the configuration directory (`~/.config/tori/packages` by default), both package lists are sorted and deduplicated before they can be filtered by each other using `grep` inverted matching. -This allows us to obtain both differences and display them to the user. If no resolution strategy has been configured, several options are displayed: +This allows obtaining both differences and displaying them to the user. If no resolution strategy has been configured or passed through the command line interface, several options are displayed: 1. Install/uninstall all 2. Enter packages to install/uninstall diff --git a/docs/utilities.md b/docs/utilities.md index 11cb17f..db4aafa 100644 --- a/docs/utilities.md +++ b/docs/utilities.md @@ -1,4 +1,4 @@ -The utilities functions available at `src/utilities.sh` provide functionality that is either very simple in purpose or general to the whole application. +The utilities functions available at `src/utility.sh` provide functionality that is either very simple in purpose or general to the whole application. The two utility functions presently implemented are: