Skip to content

Commit bd8df73

Browse files
committed
DOC: Note promiscuous delegations in repo creation docs
Add a note to the delegation creation sections of docs/CLI.md and docs/TUTORIAL.md that makes clear that two roles A and B can delegate to the same role C without a problem - that the delegation graph need not be a tree. Also corrects a minor typo in TUTORIAL.md Signed-off-by: Sebastien Awwad <[email protected]>
1 parent 8d5dd3b commit bd8df73

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

docs/CLI.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,11 @@ For example, to delegate trust of `/foo*.gz` packages to the `foo` role:
140140
$ repo.py --delegate "/foo*.tgz" --delegatee foo --pubkeys ./keystore/foo.pub
141141
```
142142

143+
Note that multiple roles can delegate to the same role; the delegation graph
144+
does not have to be a tree. Roles A and B might independently delegate paths to
145+
the same role, C.
146+
Cycles are detected and cut short in the depth first traversal the updater
147+
performs to search for metadata about a target.
143148

144149

145150
## Revoke trust ##

docs/TUTORIAL.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ specification and [METADATA.md](METADATA.md) for a detailed example.
463463
All of the target files available on the software repository created so far
464464
have been added to one role (the top-level Targets role). However, what if
465465
multiple developers are responsible for the files of a project? What if
466-
responsiblity separation is desired? Performing a delegation, where one role
466+
responsibility separation is desired? Performing a delegation, where one role
467467
delegates trust of some paths to another role, is an option for integrators
468468
that require additional roles on top of the top-level roles available by
469469
default.
@@ -509,6 +509,13 @@ Dirty roles: ['timestamp', 'snapshot', 'targets', 'unclaimed']
509509
>>> repository.writeall()
510510
```
511511

512+
Note that multiple roles can delegate to the same role; the delegation graph
513+
does not have to be a tree. Roles A and B might independently delegate paths to
514+
the same role, C.
515+
Cycles are detected and cut short in the depth first traversal the updater
516+
performs to search for metadata about a target.
517+
518+
512519
#### Revoke Delegated Role ####
513520
```python
514521
# Continuing from the previous section . . .

0 commit comments

Comments
 (0)