From 842746ee205f1b35bbd4af8621f2b2cc9f3eb1ef Mon Sep 17 00:00:00 2001 From: Jussi Kukkonen Date: Mon, 23 Aug 2021 10:46:25 +0300 Subject: [PATCH] docs: Improve ngclient docs Signed-off-by: Jussi Kukkonen --- docs/api/tuf.ngclient.rst | 9 ++++++++- tuf/ngclient/updater.py | 6 +++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/api/tuf.ngclient.rst b/docs/api/tuf.ngclient.rst index 3a31edbc92..df705bbf03 100644 --- a/docs/api/tuf.ngclient.rst +++ b/docs/api/tuf.ngclient.rst @@ -1,8 +1,15 @@ ngclient ======== +The ngclient module contains a complete TUF client library implementation. + +* :doc:`tuf.ngclient.updater` implements the client update workflow +* :doc:`tuf.ngclient.config` provides optional configuration for the updater +* :doc:`tuf.ngclient.fetcher` can be used for optional low-level network I/O control + + .. toctree:: - :maxdepth: 4 + :hidden: tuf.ngclient.updater tuf.ngclient.config diff --git a/tuf/ngclient/updater.py b/tuf/ngclient/updater.py index 561615932c..205328159c 100644 --- a/tuf/ngclient/updater.py +++ b/tuf/ngclient/updater.py @@ -1,9 +1,9 @@ # Copyright 2020, New York University and the TUF contributors # SPDX-License-Identifier: MIT OR Apache-2.0 -"""TUF module that implements the client update workflow. +"""Client update workflow implementation -This module contains the Updater class that provides an implementation of the +The Updater class provides an implementation of the `TUF client workflow `_. Updater provides an API to query available targets and to download them in a @@ -37,7 +37,7 @@ metadata at "/tuf-repo/" and targets at "/targets/" * Local metadata directory "~/tufclient/metadata/" is writable and contains a root metadata version for the remote repository - * Download directory "~/target-downloads/" is writable + * Download directory "~/tufclient/downloads/" is writable Example::