Skip to content

Commit d841702

Browse files
authored
doc: add warning for ignored data (#83)
* doc: add warning for ignored data * fix
1 parent ca6c3c0 commit d841702

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

docs/config.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,12 @@ Changelog:
285285

286286
Deprecated since v1.8.0. Use [ignore_patterns](#ignore_patterns) instead
287287

288+
!!! danger
289+
290+
Files matched by `ignored_files` are also not considered during restore.
291+
After the restore, only those files that were backed up will exist in the target folders.
292+
Only use this option for useless files.
293+
288294
A list of file / directory names to be ignored during backup
289295

290296
If the name string starts with `*`, then it will ignore files with name ending with specific string,
@@ -297,6 +303,12 @@ e.g. `temp*` makes all files starts with `temp` be ignored, like `tempfile`
297303

298304
#### ignore_patterns
299305

306+
!!! danger
307+
308+
Files matched by `ignore_patterns` are also not considered during restore.
309+
After the restore, only those files that were backed up will exist in the target folders.
310+
Only use this option for useless files.
311+
300312
A list of [gitignore flavor](http://git-scm.com/docs/gitignore) patterns for matching files / directories to be excluded during the backup
301313

302314
The root path for the pattern matching is [source_root](#source_root).

docs/config.zh.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,12 @@ Prime Backup 在创建备份时的操作时序如下:
285285

286286
于 v1.8.0 弃用。请使用 [ignore_patterns](#ignore_patterns)
287287

288+
!!! danger
289+
290+
`ignored_files` 匹配的文件在回档时不会被保留。
291+
回档后,目标文件夹中只存在已备份的内容。
292+
仅对无用数据使用此选项。
293+
288294
在备份时忽略的文件名列表
289295

290296
若文件名字符串以 `*` 开头,则将忽略以指定字符串结尾的文件,
@@ -297,6 +303,12 @@ Prime Backup 在创建备份时的操作时序如下:
297303

298304
#### ignore_patterns
299305

306+
!!! danger
307+
308+
`ignore_patterns` 匹配的文件在回档时不会被保留。
309+
回档后,目标文件夹中只存在已备份的内容。
310+
仅对无用数据使用此选项。
311+
300312
一个 [gitignore 风格](http://git-scm.com/docs/gitignore) 的模板串列表,用于在创建备份的过程中匹配并忽略指定的文件 / 文件夹
301313

302314
模板串匹配时的根路径是 [source_root](#source_root)

0 commit comments

Comments
 (0)