New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve layout configuration part of the user guide #3125
base: master
Are you sure you want to change the base?
Commits on Jan 9, 2024
-
Do not refer to "restore list" in the docs
This term is never defined or used anywhere. Let's talk about the layout file instead.
Configuration menu - View commit details
-
Copy full SHA for 13f5bf5 - Browse repository at this point
Copy the full SHA 13f5bf5View commit details
Commits on Jan 15, 2024
-
Configuration menu - View commit details
-
Copy full SHA for d28226e - Browse repository at this point
Copy the full SHA d28226eView commit details -
Neutral wording of the EXCLUDE_RECREATE example
Avoid the "easiest", "inadvertently" expressions.
Configuration menu - View commit details
-
Copy full SHA for d144088 - Browse repository at this point
Copy the full SHA d144088View commit details -
Don't copy EXCLUDE_BACKUP/RESTORE to layout doc
EXCLUDE_RESTORE and EXCLUDE_BACKUP are irrelevant for layout file and disk layout recreation. They merely influence file backup or restore (for supported backup methods). This guide is about the recreation of the disk layout. Therefore, omit the variables from here. They are not used in the doc anywhere anyway after showing a copy of their description originating from default.conf. So, why to show it at all?
Configuration menu - View commit details
-
Copy full SHA for adaa2f5 - Browse repository at this point
Copy the full SHA adaa2f5View commit details -
layout doc: move autoexcludes description
I believe that "This behavior is controlled by the +AUTOEXCLUDE_DISKS=y+ parameter" must refer to the exclusion of the unused backup disk. At the current location (disk layout when the backup disk is NOT unused anymore) it does not make sense. Move the whole part about autoexcludes just after the section where it is mentioned that a disk was automatically excluded.
Configuration menu - View commit details
-
Copy full SHA for 84f914e - Browse repository at this point
Copy the full SHA 84f914eView commit details -
Do not copy almost identical layout file in docs
Show only the parts that have changed after changing something.
Configuration menu - View commit details
-
Copy full SHA for 1e56ae1 - Browse repository at this point
Copy the full SHA 1e56ae1View commit details -
Update whitespace after comment in layout examples
4d6fac7 changed the formatting of commented entries in layout: "Change commenting in layout file to have no space after the #." Adapt the examples that had been generated before the change to match.
Configuration menu - View commit details
-
Copy full SHA for 6a97ccd - Browse repository at this point
Copy the full SHA 6a97ccdView commit details -
Describe EXCLUDE_RECREATE in layout docs better
Instead of copying a snippet of default.conf, describe in prose what the variable does and what is the syntax.
Configuration menu - View commit details
-
Copy full SHA for bc32027 - Browse repository at this point
Copy the full SHA bc32027View commit details -
Describe assumptions of the layout conf example
Instead of referring to what seems prudent, describe the assumptions beyond the example explicitly. This way, the reader can understand what we want to achieve, regardless what is their opinion on what is prudent and what is not. Also, describe briefly the relation between layout configuration and backup exclusion.
Configuration menu - View commit details
-
Copy full SHA for a899b96 - Browse repository at this point
Copy the full SHA a899b96View commit details -
Configuration menu - View commit details
-
Copy full SHA for 16d6be5 - Browse repository at this point
Copy the full SHA 16d6be5View commit details