Skip to content

Commit 26ad4ef

Browse files
committed
Updated the documentation, to be in line with the new architecture, and
unwritten conventions.
1 parent c696389 commit 26ad4ef

File tree

3 files changed

+39
-18
lines changed

3 files changed

+39
-18
lines changed

Docs/technical/namingconventions.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ conventions, used thoughout the system.
1818

1919
see folder structure.
2020

21-
* Naming conventions for dropin delegates/executionors.
21+
* Naming conventions used by dropin delegates/executionors.
2222

23+
* Naming conventions for scripts of various kinds
2324

2425
## Periodic backup destination folder structure
2526

@@ -252,6 +253,14 @@ whether it is a local dropin folder or the general dropin
252253
folder must have exactly the same name.
253254

254255

256+
## Naming conventions for scripts of various kinds
257+
258+
Routines that are commands and meant to be used from the cli
259+
doesn't end in `.sh`. Scripts that are intendend to be
260+
executed/sourced by other scripts and not by people,
261+
**ends** in `.sh`.
262+
263+
255264
## Customizability of the variables, kinds, and schemes
256265

257266
### The FB literal name for the root of your backup repo can be changed.
@@ -283,5 +292,5 @@ break the scripts.
283292

284293
They are hardcoded into the scripts as kinds as described above.
285294

286-
Last updated:23-02-02 18:59
295+
Last updated:23-02-03 11:26
287296

Docs/technical/systemsoverview.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,16 @@ three tiers of classes of routines
1414
### The tiers of routines
1515

1616

17-
### Governor class:
17+
### Executive class:
1818

1919
The service triggered routine is named `governor.sh` and serves
20-
all periodic backups.
20+
all periodic backups. it is triggered -- normally -- by a
21+
service.
2122

2223
The user triggered routine are named `fbctl` and
2324
`fbinstall`.
2425

25-
### Manager
26+
### Manager class
2627

2728
The user triggered commands at this level are `fbrestore` and
2829
`fbsnapshot`, since those are slightly deviating from the rest of
@@ -31,14 +32,16 @@ the naming schemes.
3132
the managers basically takes care of finding which delegate
3233
to run.
3334

34-
### the agent/delegate/executioner
35+
### the agent/delegate class
3536

3637
The delegates are the low level workers, their job is also
3738
to figure out if there are any exclude files involved.
3839

40+
exclude files are of no use to `fbrestore`
3941

4042

4143

4244

43-
Last updated:23-02-02 23:14
45+
46+
Last updated:23-02-03 11:20
4447

Docs/technical/termsandjargon.md

+20-11
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,23 @@ minimize ambiguity and confusion.
4343
--->
4444

4545
* **Container**. A **Container** for backups.
46-
The `TIME_STAMPED_BACKUP_CONTAINING_FOLDER`: the folder
47-
containing backups from that date onwards, depending on
48-
the **scheme**.
46+
The `TIME_STAMPED_BACKUP_CONTAINING_FOLDER`: the folder
47+
containing backups from that date onwards, depending on
48+
the **scheme**.
4949

50-
* **Delegate** The actual executionor of the job, whether
51-
the job is performed on behalf of a manager?, called by the
52-
governor, or by a fbsnapshot.
50+
* **Delegate** A class of scripts that actually performs a backup
51+
operation, whether it is taking a backup, or restoring a
52+
backup. The **delegate** is chosen by the *manager*,
53+
called by an *executive*.
54+
55+
* **Executioner** See: *delegate*.
56+
57+
* **Executive** The script that controls a *job*, calls the
58+
*manager* if need be that dispatches the correct *delegate*.
59+
An executive is the top level layer of all the routines that
60+
works on the the system, the user commands, and the scripts
61+
that gets called by the services.
5362

54-
* **Executioner** It's the *delegate*, that performs the
55-
actual job, on the behalf of the **Governor**, that
56-
qualifies and selects what to be done, and then gets the
57-
**Executioner** to do it.
5863

5964
* **Full-symlink-name** The **full-symlink-name** is a
6065
*transformation of the full path to the target of the
@@ -80,6 +85,10 @@ minimize ambiguity and confusion.
8085
* **KIND** (Backup kind.) Denotes if it is a `OneShot` or a
8186
`Periodical` backup kind.
8287

88+
* **Manager** The manager, is the single script for all
89+
*jobs*/executives that gets sourced in, and chooses which
90+
delegate to choose.
91+
8392

8493
* **snapshot** This word has two different meanings.
8594
I use it for a full backup at a given point in time, as to
@@ -144,5 +153,5 @@ minimize ambiguity and confusion.
144153

145154
* Monthly a `calendar-intervalled` backup.
146155

147-
Last updated:23-02-02 16:32
156+
Last updated:23-02-03 11:20
148157

0 commit comments

Comments
 (0)