From fbc02d303457f2f249654111844c08996fa1fbfa Mon Sep 17 00:00:00 2001 From: Vladimir Diaz Date: Thu, 21 Jun 2018 11:19:59 -0400 Subject: [PATCH] Use a working example in the overview section Some users will actually attempt to execute the example listed in the overview section. Use a working example that doesn't raise an error. Signed-off-by: Vladimir Diaz --- docs/TUTORIAL.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/TUTORIAL.md b/docs/TUTORIAL.md index 0fefe4dd..c3d55152 100644 --- a/docs/TUTORIAL.md +++ b/docs/TUTORIAL.md @@ -35,11 +35,11 @@ software repository is the focus of this tutorial. There is also separate document that [demonstrates how TUF protects against malicious updates](../tuf/ATTACKS.md). -The [repository tool](../tuf/repository_tool.py) contains functions to generate all of -the files needed to populate and manage a TUF repository. The tool may either -be imported into a Python module, or used with the Python interpreter in -interactive mode. For instance, here is an example of loading a TUF repository -in interactive mode: +The [repository tool](../tuf/repository_tool.py) contains functions to generate +all of the files needed to populate and manage a TUF repository. The tool may +either be imported into a Python module, or used with the Python interpreter in +interactive mode. For instance, here is an example of initializing a TUF +repository in interactive mode: ```Bash $ python @@ -47,7 +47,7 @@ Python 2.7.3 (default, Sep 26 2013, 20:08:41) [GCC 4.6.3] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> from tuf.repository_tool import * ->>> repository = load_repository("path/to/repository") +>>> repo = create_new_repository("my_repo") ``` A repository object that encapsulates the metadata files of the repository can