python-tuf/docs
Lukas Puehringer 7e8b7e5db1 doc: Explicitly mark roles dirty in tutorial
TUF does not reliably mark roles as dirty whose metadata needs
to be re-generated.

Only roles that have changed are marked as dirty, but sometimes
roles metadata needs to be updated, although the role wasn't
changed directly (see #958).

Furthermore, the tutorial assumes at one point that the reader
leaves and re-enter the interpreter session, being forced to reload the
signing keys, roles that later need to be re-written, are marked as
dirty. If the reader does not leave the interpreter, the roles are
not marked as dirty (see #964).

To not confuse the reader with flawed state-keeping, and to never
write an inconsistent repository to disk, the tutorial lets the
reader explicitly mark all roles that need to be re-written as
"dirty".

This can be changed once above issues are fixed.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2019-12-16 15:16:24 +01:00
..
images Add banner_readme.png 2018-01-23 16:36:51 -05:00
latex Fix some typos in docs 2019-02-25 17:00:26 +07:00
papers Add Mercury paper and entry in README.rst 2017-08-31 10:13:05 -04:00
ADOPTERS.md Add signoff to commit 2019-02-22 09:08:52 +07:00
AUTHORS.txt Explaining GOVERNANCE structure to better match CNCF graduation ask 2018-10-11 10:50:47 -04:00
CHANGELOG.md CHANGELOG: Add v0.12.1 entry 2019-11-14 15:49:10 +01:00
CLI.md DOC: collapse CLI_EXAMPLES.md into CLI.md 2019-04-08 11:54:10 -04:00
CODE-OF-CONDUCT.md Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
CONTRIBUTORS.rst Add extra installation instruction to contrib doc 2019-09-18 10:21:53 +02:00
GETTING_STARTED.rst DOC: collapse CLI_EXAMPLES.md into CLI.md 2019-04-08 11:54:10 -04:00
GOVERNANCE.md Governance clarifications 2019-11-11 15:51:52 +01:00
INSTALLATION.rst DOC: move full install instructions to INSTALLATION.rst 2019-04-08 17:13:11 -04:00
MAINTAINERS.txt Update MAINTAINERS.txt 2019-11-05 09:56:28 -05:00
METADATA.md Update deprecated url 2019-02-21 16:50:19 +07:00
OVERVIEW.rst Update deprecated links in docs 2019-02-26 08:58:59 +07:00
QUICKSTART.md DOC: cover possible environment requirements in QUICKSTART 2019-04-08 15:21:52 -04:00
ROADMAP.md DOC: Update the outdated ROADMAP.md 2019-02-26 11:22:47 -05:00
SECURITY.md Add slow retrieval disclaimer 2019-10-10 16:43:46 +02:00
TAP.rst Move docs to the docs/ directory 2018-01-24 10:57:01 -05:00
tuf-spec.0.9.txt Update link to historical tuf-spec.0.9.txt 2019-09-16 15:43:39 +02:00
tuf-spec.md Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
tuf-spec.txt Edit specifiation files to point to their new location 2017-10-11 15:49:47 -04:00
TUTORIAL.md doc: Explicitly mark roles dirty in tutorial 2019-12-16 15:16:24 +01:00