Skip to content

Commit 1211c96

Browse files
committed
Rename "Usage" to "Repository operations"
Rename the "Usage" section to "Repository operations" and move the "Consistent snapshots" section within. Signed-off-by: Joshua Lock <[email protected]>
1 parent bceeb81 commit 1211c96

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

tuf-spec.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -304,8 +304,8 @@ configured repository.
304304
The root role's private keys MUST be kept very secure and thus should be
305305
kept offline. If less than a threshold of Root keys are compromised, the
306306
repository should revoke trust on the compromised keys. This can be
307-
accomplished with a normal rotation of root keys, covered in section 6.1
308-
(Key management and migration). If a threshold of root keys is compromised,
307+
accomplished with a normal rotation of root keys, covered in section
308+
[[#key-management-and-migration]]. If a threshold of root keys is compromised,
309309
the Root keys should be updated out-of-band, however, the threshold should
310310
be chosen so that this is extremely unlikely. In the unfortunate event that
311311
a threshold of keys are compromised, it is safest to assume that attackers
@@ -689,8 +689,8 @@ The "signed" portion of <a>root.json</a> is as follows:
689689
: <dfn>CONSISTENT_SNAPSHOT</dfn>
690690
::
691691
A boolean indicating whether the repository supports
692-
consistent snapshots. Section 7 goes into more detail on the consequences
693-
of enabling this setting on a repository.
692+
consistent snapshots. Section [[#consistent-snapshots]] goes into more
693+
detail on the consequences of enabling this setting on a repository.
694694

695695
: <dfn for="role">VERSION</dfn>
696696
::
@@ -1505,10 +1505,10 @@ it in the next step.
15051505
metadata file found earlier in step [[#update-targets]]. In either
15061506
case, the client MUST write the file to non-volatile storage as FILENAME.EXT.
15071507

1508-
# 6. Usage # {#usage}
1508+
# Repository operations # {#repository-operations}
15091509

1510-
See [https://theupdateframework.io/](https://theupdateframework.io/) for discussion of
1511-
recommended usage in various situations.
1510+
See [https://theupdateframework.io/](https://theupdateframework.io/) for
1511+
discussion of recommended usage in various situations.
15121512

15131513
## Key management and migration ## {#key-management-and-migration}
15141514

@@ -1550,7 +1550,7 @@ To replace a delegated developer key, the role that delegated to that key
15501550
just replaces that key with another in the signed metadata where the
15511551
delegation is done.
15521552

1553-
# Consistent Snapshots # {#consistent-snapshots}
1553+
## Consistent snapshots ## {#consistent-snapshots}
15541554

15551555
So far, we have considered a TUF repository that is relatively static (in
15561556
terms of how often metadata and target files are updated). The problem is
@@ -1565,7 +1565,7 @@ so-called consistent snapshot. If a client is reading from one consistent
15651565
snapshot, then the repository is free to write another consistent snapshot
15661566
without interrupting that client.
15671567

1568-
## Writing consistent snapshots ## {#writing-consistent-snapshots}
1568+
### Writing consistent snapshots ### {#writing-consistent-snapshots}
15691569

15701570
We now explain how a repository should write metadata and targets to
15711571
produce self-contained consistent snapshots.
@@ -1616,7 +1616,7 @@ released versions of root metadata files should always be provided
16161616
so that outdated clients can update to the latest available root.
16171617

16181618

1619-
## Reading consistent snapshots ## {#reading-consistent-snapshots}
1619+
### Reading consistent snapshots ### {#reading-consistent-snapshots}
16201620

16211621
See [[#detailed-client-workflow]] for more details.
16221622

0 commit comments

Comments
 (0)