quico-os-setup/zfs-pacman-hook
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

docs(conf): Add comment per setting (#1)

Browse Source
This commit is contained in:
hygienic-books 2023-03-07 01:10:38 +01:00
parent 9e8772fad5
commit 47bb8cbd30
1 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
pacman-zfs-snapshot.conf
View File

@ -1,19 +1,27 @@
do_dry_run='true' # Set to 'true' to do nothing and just print messages during pacman
# operations. Helpful to get a feel for what these hooks do. This defaults
# to 'true' so if you set this to an empty string or remove or uncomment it
# in this conf file it'll equal 'true'.
do_dry_run='false'
# Pipe-separated list of kernel names. Will be matched against regular # Pipe-separated list of package names we consider important. Will be
# expression ^this_var_here$. Snapshots taken before a pacman transaction on # matched against regular expression ^(this_var_here)$. Snapshots taken
# an important package have a separate retention from snapshots for trivial # before a pacman transaction on an important package have a separate
# packages. Lends itself to keeping kernel updates separate from everything # retention from snapshots for trivial packages. Lends itself to keeping
# else. # high-risk updates separate from everything else.
important_names='tmux' important_names='linux|systemd|zfs-(dkms|utils)'
# zfs pkgs, systemd?
# Number snapshots to keep
snaps_trivial_keep='15' snaps_trivial_keep='15'
snaps_important_keep='5' snaps_important_keep='5'
# Which suffix to use in snapshot names to identify snapshots before a
# trivial pacman operation and before important pacman operations.
snaps_trivial_suffix='trv' snaps_trivial_suffix='trv'
snaps_important_suffix='imp' snaps_important_suffix='imp'
# Snapshot name will contain list of affected packages trimmed to this many
# max characters.
pkgs_list_max_length='30' pkgs_list_max_length='30'
# Hook will by default snapshot all datasets that have the property # Hook will by default snapshot all datasets that have the property
@ -26,10 +34,17 @@ pkgs_list_max_length='30'
# jq --raw-output '.[][] | select(.fstype=="zfs") | .source' # jq --raw-output '.[][] | select(.fstype=="zfs") | .source'
snap_only_local_datasets='true' snap_only_local_datasets='true'
# Which characters do we want to use to separate snapshot name fields
snap_field_separator='_' snap_field_separator='_'
snap_name_prefix='pac' # Prefix all our snapshots with this string to keep them separate from
# snapshots done by any other means
snap_name_prefix='pacman'
# We do "$(date +<whatever>)" to put a timestamp into snapshot names.
# Defaults to "$(date +<whatever>)" which returns '2023-03-07-0050'.
snap_date_format='%F-%H%M' snap_date_format='%F-%H%M'
# Which strings do we want to diffferentiate pacman operations Install,
# Remove, Upgrade
snap_op_installation_suffix='inst' snap_op_installation_suffix='inst'
snap_op_remove_suffix='rmvl' snap_op_remove_suffix='rmvl'
snap_op_upgrade_suffix='upgr' snap_op_upgrade_suffix='upgr'