Document the system.conf tokens in the manual page #1251
Comments
evelikov
added
the
enhancement
|
I'd say a man page is primarily useful if the system you read it on is the system you use this information for. The How would you use the man page? Do you write the |
|
Some context - last week I was travelling for All Systems Go 2023 where I met some of your amazing colleagues. As Jan mentioned the http-streaming, which got interested and went through the manual page. Only the notice the notable gap wrt system.conf. In terms of actual use-case, I would say a bit of both: be that live system and standalone devel/config. For example: while working on the SteamDeck, we had cases where the system.conf was missing all together or had invalid modifications - some of those will be reduced with #1252. Even so, having at least a basic aka terse offline documentation would be appreciated. One might be flying, or dare I say it ISP or rtd.io may go down. Having a documented |
|
It seems a full example If we can figure out nice way to generate the manpage and the HTML docs from the same input, that would be nice. Otherwise, perhaps the HTML (or text?) docs should be built and installed to |
|
Having html/text docs in Please don't read the latter as a deterrent. |
|
OK, we see two easier improvements, which could be done without duplicating the information from the
With this, the distros can decide if they want to install that by default. |
Currently there is a limited set of documentation installed by default. We already have the sphinx docs wired into the meson build, although there is no way for the end-user to install them. Add an `htmldocs` option which guards both build and install of the docs. Thus people can opt out of, even if they have sphinx installed. Issue: rauc#1251 Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
|
First piece - installing htmldocs to |
Currently there is a limited set of documentation installed by default. We already have the sphinx docs wired into the meson build, although there is no way for the end-user to install them. Add an `htmldocs` option which guards both build and install of the docs. Thus people can opt out of, even if they have sphinx installed. v2: - disable by default - tweak CI doc stage, to build a minimal almost docs-only build Issue: rauc#1251 Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Currently there is a limited set of documentation installed by default. We already have the sphinx docs wired into the meson build, although there is no way for the end-user to install them. Add an `htmldocs` option which guards both build and install of the docs. Thus people can opt out of, even if they have sphinx installed. v2: - disable by default - tweak CI doc stage, to build a minimal almost docs-only build v3: - allow building, without forcing the installation Issue: rauc#1251 Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Currently there is a limited set of documentation installed by default. We already have the sphinx docs wired into the meson build, although there is no way for the end-user to install them. Add an `htmldocs` option which guards both build and install of the docs. Thus people can opt out of, even if they have sphinx installed. v2: - disable by default - tweak CI doc stage, to build a minimal almost docs-only build v3: - allow building, without forcing the installation v4: - capitalise HTML in meson_options - trim down meson setup command Issue: rauc#1251 Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Is your feature request related to a problem? Please describe.
Currently
man raucmentions/etc/rauc/system.confand that it has an ini style format. Although it does no cover the sections and options one can use within. Currently one has to (admittedly very useful) readthedocs website.Having the information available offline would be amazing.
Describe the solution you'd like
Enhance the existing rauc manual entry to cover the sections/option/etc supported by system.conf
Describe alternatives you've considered
Depending on size or how annoying it's to auto-generate, a separate manual page might be easier? I don't have any opinion on the topic.
The text was updated successfully, but these errors were encountered: