Skip to content

Commit 30bfa02

Browse files
Fallen-BreathFallen-Breath
committed
doc refine
1 parent 5a55dd5 commit 30bfa02

13 files changed

Lines changed: 41 additions & 41 deletions

‎README.zh.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
- 流畅的游戏内交互，大部分操作都能点点点
1616
- 完善的备份操作：包括备份回档、列表查看、差异展示、导入导出等
1717
- 丰富的数据库工具，含对象查询、数据库概览、数据完整性校验、孤儿数据清理、备份文件删除、哈希/压缩算法迁移等功能
18-
- 高可自定义备份清理策略，是 [PBS](https://pbs.proxmox.com/docs/prune-simulator/) 所用策略的同款
18+
- 高度可自定义的备份清理策略，是 [PBS](https://pbs.proxmox.com/docs/prune-simulator/) 所用策略的同款
1919
- 定时任务：支持自动创建备份和自动清理备份，计划方式支持固定间隔和 crontab 表达式
2020
- 支持作为命令行工具使用，无需启动 MCDR 即可管理备份，还可以通过 FUSE 挂载为文件系统进行访问
2121

@@ -40,7 +40,7 @@ Prime Backup 使用一个自定义的文件池来存储备份数据，池中的
4040

4141
对于体积较大且仅被局部修改的文件，Prime Backup 可选择启用数据分块功能来提升去重效率。
4242
此时，文件会被切分成多个数据块（chunk），每个数据块都会计算哈希值。
43-
如果数据块的内容没有改变，它就可以在不同的备份中被复用，只有新的数据块载荷会作为打包条目写入存储
43+
如果数据块的内容没有改变，它就可以在不同的备份中被复用，只有新的数据块载荷会作为打包条目写入
4444

4545
Prime Backup 支持常见的文件类型，包括普通文件、目录和符号链接；对于这三类文件：
4646

‎docs/cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ options:
7777
'.prime_backup.meta.json' in the exported file
7878
```
7979

80-
As a demonstration, here's an example usage that shows the overview of the database
80+
As a demonstration, here's an example that shows the overview of the database
8181

8282
```
8383
$ python3 PrimeBackup.pyz -d run/pb_files overview

‎docs/command.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ The root `!!pb` command shows the welcome page
1616

1717
## Command list overview
1818

19-
Use `!!pb help` to have a full view of all commands
19+
Use `!!pb help` to see a full list of all commands
2020

2121
![!!pb help](img/pb_help.png)
2222

2323
## TODO
2424

25-
TODO: More command usages
25+
TODO: More command usage

‎docs/config.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ When time exceeds, the command will be cancelled
124124

125125
#### backup_on_restore
126126

127-
If an automatically backup should be made before restoring the world to a given backup. These automatic pre-restore backups are temporary backups
127+
Whether an automatic backup should be made before restoring the world to a given backup. These automatic pre-restore backups are temporary backups
128128

129129
This is a safeguard prepared for those idiot users
130130

@@ -411,7 +411,7 @@ However, this also introduces the potential risk of incomplete backups
411411

412412
#### creation_skip_missing_file
413413

414-
In certain scenarios, server plugins / mods do not respect to the `/save off` command,
414+
In certain scenarios, server plugins / mods do not respect the `/save off` command,
415415
and may still delete files when PB is creating a backup.
416416
These missing files can cause the backup operation to fail due to file not found errors
417417

@@ -532,7 +532,7 @@ The algorithm to hash the files. Available options: `"xxh128"`, `"sha256"`, `"bl
532532

533533
| Hash Method | Description | Speed | cryptographically secure |
534534
|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|--------------------------|
535-
| [`xxh128`](https://github.com/Cyan4973/xxHash) | A extremely fast, high-quality 128bit non-cryptographic hash algorithm. Recommend to use, unless you want theoretic extreme safety on hackers | ★★★★★ | :cross_mark: |
535+
| [`xxh128`](https://github.com/Cyan4973/xxHash) | An extremely fast, high-quality 128bit non-cryptographic hash algorithm. Recommend to use, unless you want theoretic extreme safety on hackers | ★★★★★ | :cross_mark: |
536536
| [`sha256`](https://en.wikipedia.org/wiki/SHA-2) | A cryptographically secure and widely used 256bit hash algorithm. It's slower than xxh128, but the speed could be acceptable using cpu with hardware acceleration | ★★ | :check_mark: |
537537
| [`blake3`](https://github.com/BLAKE3-team/BLAKE3) | A cryptographically secure and speedy 256bit hash algorithm. It's still slower than xxh128, but is much faster than sha256 | ★★★☆ | :check_mark: |
538538

‎docs/config.zh.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ Prime Backup 在创建备份时的操作时序如下：
275275

276276
要备份的目标文件/目录。它们也可以是 [gitignore 风格](http://git-scm.com/docs/gitignore) 的模板串
277277

278-
通常来讲，你需要在整理添加你的存档文件夹的名字
278+
通常来讲，你需要在这里填写你的存档文件夹的名字
279279

280280
例如，对于像 bukkit 那样把每个维度存在独立的文件夹里的服务器，你可能需要这么配置：
281281

@@ -374,7 +374,7 @@ world --> foo --> bar
374374
备份目标
375375
```
376376

377-
Prime Backup 除了会保存 `world` 这个符号链接外，还会保存 `foo` 符号链接，和最终的的 `bar` 文件夹
377+
Prime Backup 除了会保存 `world` 这个符号链接外，还会保存 `foo` 符号链接，和最终的 `bar` 文件夹
378378

379379
- 类型：`bool`
380380
- 默认值：`false`
@@ -393,7 +393,7 @@ Prime Backup 会检查文件的如下这些信息。下述这些信息完全一
393393
- 文件的修改时间（精度：纳秒）
394394

395395
如果你想获得尽可能快的备份创建速度，可以尝试启用此选项，但这会引入潜在的备份不完整的风险。
396-
除非你确实需要这一备份速度增益，或者系统磁盘读取性能过低，否则不建议启用此选项
396+
除非你确实需要这一备份速度提升，或者系统磁盘读取性能过低，否则不建议启用此选项
397397

398398
!!! warning
399399

@@ -403,15 +403,15 @@ Prime Backup 会检查文件的如下这些信息。下述这些信息完全一
403403

404404
!!! tip
405405

406-
除非你确实需要这一备份速度增益，或者系统磁盘读取性能过低，否则不建议启用此选项。
406+
除非你确实需要这一备份速度提升，或者系统磁盘读取性能过低，否则不建议启用此选项。
407407
Prime Backup 的速度已经足够快了
408408

409409
- 类型：`bool`
410410
- 默认值：`false`
411411

412412
#### creation_skip_missing_file
413413

414-
在某些场景下，服务端的插件 / mod 并不会遵从 /save off` 命令，
414+
在某些场景下，服务端的插件 / mod 并不会响应 `/save off` 命令，
415415
在 PB 创建备份时仍可能执行删除文件的操作。
416416
这些缺失的文件会导致备份操作因找不到文件而失败
417417

@@ -426,7 +426,7 @@ Prime Backup 会检查文件的如下这些信息。下述这些信息完全一
426426
#### creation_skip_missing_file_patterns
427427

428428
一个 [gitignore 风格](http://git-scm.com/docs/gitignore) 的模板串列表，
429-
与 [creation_skip_missing_file_patterns](#creation_skip_missing_file_patterns) 选项配合使用
429+
与 [creation_skip_missing_file](#creation_skip_missing_file) 选项配合使用
430430

431431
在创建备份的过程中，该选项匹配中的文件发生的“文件不存在”错误将被忽略
432432

@@ -587,7 +587,7 @@ Prime Backup 会检查文件的如下这些信息。下述这些信息完全一
587587

588588
#### pack_auto_compact_threshold
589589

590-
删除数据块后自动整理打包文件时使用的存活数据阈值
590+
自动整理打包文件时使用的存活数据阈值，当存活数据低于此比例时触发整理
591591

592592
当被修改的打包文件中的存活数据低于此比例时，Prime Backup 会将其中的存活打包条目重写到新的打包文件，并删除旧打包文件
593593

@@ -629,7 +629,7 @@ Prime Backup 会检查文件的如下这些信息。下述这些信息完全一
629629

630630
是否在每次手动备份时重置计划定时器
631631

632-
该功能仅在定时备份作业使用间隔模式的定时器的时候，才有效果
632+
该功能仅在定时备份作业使用间隔模式时才有效
633633

634634
- 类型：`bool`
635635
- 默认值：`true`
@@ -638,7 +638,7 @@ Prime Backup 会检查文件的如下这些信息。下述这些信息完全一
638638

639639
若设为 `true`，则只有在服务器中存在玩家时，才正常进行定时备份。
640640
如果所有玩家均已离线，则在下一次定时备份完成后，之后的定时备份都会被跳过。
641-
也就是说，Prime Backup 在没有玩家在线上时，只会触发一次定时备份
641+
也就是说，Prime Backup 在没有玩家在线时，只会触发一次定时备份
642642

643643
时间线举例：
644644

@@ -761,7 +761,7 @@ Prime Backup 会执行以下步骤来决定删除/保留哪些备份
761761
1. 使用 [`last`, `hour`, `day`, `week`, `month`, `year`](#last-hour-day-week-month-year)，
762762
基于 [PBS](https://pbs.proxmox.com/docs/prune-simulator/) 保留策略，筛选出要删除/保留的备份
763763
2. 使用 `max_amount`、`max_lifetime` 这两条规则，在第一步保留的那些备份里，筛出那些旧的和过期的备份
764-
3. 收集上述两次筛选过程中，找到的哪些需要删除的备份，并逐个进行删除
764+
3. 收集上述两次筛选过程中，找到的那些需要删除的备份，并逐个进行删除
765765

766766
删除备份相关的决策结果会以日志形式储存在 [数据根目录](#storage_root) 的 `logs/prune.log` 文件里
767767

@@ -864,7 +864,7 @@ Prime Backup 所使用的 SQLite 数据库的相关配置
864864

865865
数据库精简作业
866866

867-
它对数据库使用了 [VACUUM](https://www.sqlite.org/lang_vacuum.html)指令， 以精简数据库文件，并释放未使用的空间
867+
它对数据库使用了 [VACUUM](https://www.sqlite.org/lang_vacuum.html) 指令，以精简数据库文件，并释放未使用的空间
868868

869869
#### backup
870870

@@ -905,7 +905,7 @@ Prime Backup 所使用的 SQLite 数据库的相关配置
905905
一个定时作业相关的配置，用于描述该作业会在什么时候执行。有两种模式：
906906

907907
- 间隔模式：按给定的时间间隔执行作业。第一次执行也要等待给定的间隔
908-
- 定时模式: 在特定时间执行作业，由 crontab 字符串描述
908+
- 定时模式：在特定时间执行作业，由 crontab 字符串描述
909909

910910
若作业被启用，你必须选择上述模式之一，并正确设置相关配置值
911911

@@ -945,7 +945,7 @@ Prime Backup 所使用的 SQLite 数据库的相关配置
945945

946946
#### jitter
947947

948-
两次作业之间，执行之间的抖动
948+
作业执行间隔的随机抖动量
949949

950950
下一个任务的实际执行时间，将在范围 `[0, jitter]` 内进行随机偏移
951951

@@ -959,11 +959,11 @@ Prime Backup 所使用的 SQLite 数据库的相关配置
959959

960960
### Duration
961961

962-
使用字符串描述的时间持续长度，如：`"3s"`、`"15m"`
962+
以字符串表示的时间长度，如：`"3s"`、`"15m"`
963963

964964
Duration 由两部分组成：数字和时间单位。
965965

966-
对于数字部分，它可以是整数或浮点数
966+
数字部分可以是整数或浮点数
967967

968968
对于单位部分，参见下表：
969969

‎docs/feature/backup_create.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Below are some commonly used configuration items
102102

103103
## Detailed Backup Process
104104

105-
Below will list the operation process during PB backup creation
105+
The following describes the operation process during PB backup creation
106106

107107
1. Interact with MC server to construct an environment suitable for backup creation (all operations below can be configured)
108108
1. Use commands such as `save-off` to disable MC's automatic saving
@@ -113,7 +113,7 @@ Below will list the operation process during PB backup creation
113113
2. If available concurrency configuration > 1, use multi-threading to pre-calculate the hash value of each file to be backed up
114114
3. For each file to be backed up, process one by one:
115115
1. Calculate hash value. If previously calculated, reuse directly
116-
2. Determine if data with this hash value has been backed up before, if not, copy a copy of the data to the backup path
116+
2. Determine if data with this hash value has been backed up before, if not, copy the data to the backup path
117117
3. Store this file's metadata and hash value in the database
118118
4. Calculate the fileset for this backup, complete the backup
119119
3. Restore operations on MC server

‎docs/feature/backup_restore.zh.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: '备份还原（回档）'
33
---
44

5-
还原一个备份，也回档操作
5+
还原一个备份，也即回档操作
66

77
## 回档步骤
88

@@ -106,7 +106,7 @@ python3 PrimeBackup.pyz -d pb_files -c config/prime_backup/config.json back -s .
106106

107107
命令行 `back` 命令不会停止或启动 Minecraft 服务端。请在运行前自行停止服务端。
108108
如果配置文件启用了 `command.backup_on_restore`，回档会创建一个临时备份。
109-
添加 `--no-pre-restore-backup` 可以跳过这个临时备份
109+
可通过 `--no-pre-restore-backup` 参数跳过此临时备份
110110

111111
## 相关配置
112112

@@ -117,7 +117,7 @@ python3 PrimeBackup.pyz -d pb_files -c config/prime_backup/config.json back -s .
117117

118118
## 回档流程详解
119119

120-
下面将列出 PB 回档备份过程中的操作流程
120+
以下是 PB 回档备份过程中的操作流程
121121

122122
1. 确认阶段
123123
1. 显示要回档的备份信息

‎docs/feature/database_maintain.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ When validation detects issues, detailed error information will be displayed:
126126

127127
### Invalid Data Cleanup
128128

129-
Prune useless stuffs as orphaned objects in the database
129+
Prune useless objects such as orphaned objects in the database
130130

131131
```
132132
!!pb database prune

‎docs/feature/database_operation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,4 @@ Notes:
6666

6767
- Cannot delete the root directory of the backup
6868
- Deleting directories requires the `--recursive` parameter
69-
- Default requires user confirmation to prevent accidental operation
69+
- By default, requires user confirmation to prevent accidental operation

‎docs/feature/database_overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 'Database Overview'
33
---
44

5-
View database statistics overview, used to quickly understand the information status of Prime Backup database
5+
View database statistics overview, used to quickly understand the current status of the Prime Backup database
66

77
## Command
88

0 commit comments

Comments
 (0)