浏览代码

Clarify documentation for `dump_data_sources` command hook (#790).

Dan Helfman 2 月之前
父节点
当前提交
c926f0bd5d
共有 1 个文件被更改,包括 2 次插入1 次删除
  1. 2 1
      docs/how-to/add-preparation-and-cleanup-steps-to-backups.md

+ 2 - 1
docs/how-to/add-preparation-and-cleanup-steps-to-backups.md

@@ -78,7 +78,8 @@ commands:
 
 
 This command hook has the following options:
 This command hook has the following options:
 
 
- * `before` or `after`: `dump_data_sources`
+ * `before` or `after`: Name for the point in borgmatic's execution that the commands should be run before or after:
+   * `dump_data_sources` runs before or after data sources are dumped (databases dumped or filesystems snapshotted) for each hook named in `hooks`.
  * `hooks`: Names of other hooks that this command hook applies to, e.g. `postgresql`, `mariadb`, `zfs`, `btrfs`, etc. Defaults to all hooks of the relevant type.
  * `hooks`: Names of other hooks that this command hook applies to, e.g. `postgresql`, `mariadb`, `zfs`, `btrfs`, etc. Defaults to all hooks of the relevant type.
  * `run`: One or more shell commands or scripts to run when this command hook is triggered.
  * `run`: One or more shell commands or scripts to run when this command hook is triggered.