Skip to content

Commit 9816c40

Browse files
committed
doc: update deprecation info in repo_example docs
Rephrase deprecation info in repo_example modules doc headers to reflect that the deprecation has happened. Signed-off-by: Lukas Puehringer <[email protected]>
1 parent ad6d2ca commit 9816c40

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

examples/repo_example/basic_repo.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
"""
22
A TUF repository example using the low-level TUF Metadata API.
33
4-
5-
As 'repository_tool' and 'repository_lib' are being deprecated, repository
6-
metadata must be created and maintained *manually* using the low-level
7-
Metadata API. The example code in this file demonstrates how to
8-
implement similar functionality to that of the legacy 'repository_tool'
9-
and 'repository_lib' until a new repository implementation is available.
10-
4+
The example code in this file demonstrates how to *manually* create and
5+
maintain repository metadata using the low-level Metadata API. It implements
6+
similar functionality to that of the deprecated legacy 'repository_tool' and
7+
'repository_lib'. (see ADR-0010 for details about repository library design)
118
129
Contents:
1310
* creation of top-level metadata

examples/repo_example/hashed_bin_delegation.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
"""
22
A TUF hash bin delegation example using the low-level TUF Metadata API.
33
4-
As 'repository_tool' and 'repository_lib' are being deprecated, hash bin
5-
delegation interfaces are no longer available in this implementation. The
6-
example code in this file demonstrates how to easily implement those
7-
interfaces, and how to use them together with the TUF metadata API, to perform
8-
hash bin delegation.
4+
The example code in this file demonstrates how to *manually* perform hash bin
5+
delegation using the low-level Metadata API. It implements similar
6+
functionality to that of the deprecated legacy 'repository_tool' and
7+
'repository_lib'. (see ADR-0010 for details about repository library design)
98
109
Contents:
1110
- Re-usable hash bin delegation helpers

0 commit comments

Comments
 (0)