Skip to content

Commit

Permalink
docs: clarify the format of string list configuration fields
Browse files Browse the repository at this point in the history
  • Loading branch information
fosskers committed Aug 4, 2024
1 parent ed5a4a9 commit 2ab1b14
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
11 changes: 9 additions & 2 deletions book/src/configuration.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Configuring Aura

For certain settings we use all the time (e.g. language, build paths, etc.),
Aura is configurable via `~/.config/aura/config.toml`. This file, with sensible
defaults, can be generated via:
Aura is configurable via `~/.config/aura/config.toml` in the [TOML
format](https://en.wikipedia.org/wiki/TOML). This file, with sensible defaults,
can be generated via:

```
aura conf --gen > ~/.config/aura/config.toml
Expand Down Expand Up @@ -46,6 +47,12 @@ Governed within the `[aur]` section.
| `nocheck` | bool | Don't run the `check()` function while building. |
| `skipdepcheck` | bool | Don't perform dependency checking at all. |

Fields of type `string list` look like this:

```toml
ignores = ["foo", "bar", "baz"]
```

## Package Snapshots

Governed within the `[backups]` section.
Expand Down
11 changes: 9 additions & 2 deletions misc/aura.texi
Original file line number Diff line number Diff line change
Expand Up @@ -1565,8 +1565,9 @@ Note that cyan nodes indicate AUR packages.
@cindex Configuration

For certain settings we use all the time (e.g. language, build paths,
etc.), Aura is configurable via @code{~/.config/aura/config.toml}. This
file, with sensible defaults, can be generated via:
etc.), Aura is configurable via @code{~/.config/aura/config.toml} in the
@url{https://en.wikipedia.org/wiki/TOML, TOML format}. This file, with
sensible defaults, can be generated via:

@example
aura conf --gen > ~/.config/aura/config.toml
Expand Down Expand Up @@ -1653,6 +1654,12 @@ See @code{aura stats --lang} for available language codes.
@tab Always reverse the search results
@end multitable

Fields of type @code{string list} look like this:

@example
ignores = ["foo", "bar", "baz"]
@end example

@heading Package Snapshots
@cindex [backups], configuration block

Expand Down

0 comments on commit 2ab1b14

Please sign in to comment.