#2997 Issue open: Improve docs for manual excludes

Labels: enhancement, documentation

danboid opened issue at 2023-05-26 20:56:

This page seems to be the official rear docs for manual excludes:

https://github.com/rear/rear/blob/master/doc/user-guide/06-layout-configuration.adoc

I'm left with a few questions after reading that.

The first thing I notice is that it makes no mention of EXCLUDE_COMPONENTS which is the only other option I've needed to use in rear so far thats not mentioned in the quickstart guide. I presume thats not an intentional omission?

I'd like to see EXCLUDE_COMPONENTS get covered on there and it should explain how EXCLUDE_COMPONENTS differs from EXCLUDE_BACKUP, if there any difference or has EXCLUDE_BACKUP supposedly deprecated EXCLUDE_COMPONENTS?

It also briefly explains EXCLUDE_RECREATE and EXCLUDE_RESTORE but from their current descriptions they sound like they do exactly the same thing.

Is EXCLUDE_BACKUP favoured over EXCLUDE_COMPONENTS? Do EXCLUDE_RECREATE and EXCLUDE_RESTORE do different things or is one favoured over the other?

Adding a few examples for excluding devices or not backing up or restoring a certain dir (or dirs) from the backup would help clarify this confusing array of very similar sounding exclude options.

jsmeix commented at 2023-05-31 12:02:

See https://github.com/rear/rear/issues/2995
for the issue that led to this improvement request.


[Export of Github issue for rear/rear.]