Commit Graph

4 Commits

Author SHA1 Message Date
Albin Vass 4e14f8e4f6 docfix: storage.overlay.pull_options should be storage.options.pull_options
Signed-off-by: Albin Vass <git@mail.albinvass.com>
2025-06-24 16:47:14 +02:00
Colin Walters 9a5c0986a4 docs: Fill in more about composefs and zstd:chunked
I've been reading more of the code and looking
at the filesystem in these modes.

Signed-off-by: Colin Walters <walters@verbum.org>
2024-08-22 15:22:22 -04:00
Colin Walters ed561808ab storage.conf: Various cleanups
The default storage.conf we ship is inconsistent in a few ways;
there's a lot of fixes rolled up into this single commit.

First: we were using a toml "inline table" for the pull options,
and then documenting each key in that table in one blob above.
It simply looks much nicer to use a non-inline table - then
we can move the docs next to each individual value. This is also
more consistent with other sections of the config.

I also thinned out a bit the doc comments; I think instead of trying
to have a longer explanation of zstd:chunked in the comments here
we should refer to the man page, which is a better place to have
details (and that we should fill out more).

Per another PR, I also stumbled across the fact that we have a
lot of "string bool" values and cannot be native TOML booleans. Document
that clearly next to each type.

We already have default values in the *code* for all
of these, so comment them all out to be consistent with other
values. (We're then getting closer to having the config file
be entirely comments, but that's a distinct project)

Finally, update the recent man pages I added to match
these changes.

Signed-off-by: Colin Walters <walters@verbum.org>
2024-08-17 14:08:26 +00:00
Colin Walters 0b440b9b56 docs: Add (not installed) man pages for composefs and zstd:chunked
These aren't installed yet so they'll just live in the git repository
but hopefully we can expand them and use them as a central reference
point for "how do I do (zstd:chunked)|(composefs)". We have copies
of that kind of instruction in other downstream places but
I think here makes the most sense.

Signed-off-by: Colin Walters <walters@verbum.org>
2024-08-04 17:21:04 -04:00