From fa59f5adfb85c91923b8f3f24dce884dafe8f2a4 Mon Sep 17 00:00:00 2001 From: Jonathan Lebon Date: Wed, 10 Aug 2016 15:11:14 -0400 Subject: [PATCH] manual/repo.md: reword bits about the summary file Closes: #459 Approved by: cgwalters --- docs/manual/repo.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/manual/repo.md b/docs/manual/repo.md index bce7e0c9..c23a4453 100644 --- a/docs/manual/repo.md +++ b/docs/manual/repo.md @@ -113,7 +113,7 @@ that. A later addition to OSTree is the concept of a "summary" file, created via the `ostree summary -u` command. This was introduced for a few -reasons. A primary use case is to be a target a +reasons. A primary use case is to be compatible with [Metalink](https://en.wikipedia.org/wiki/Metalink), which requires a single file with a known checksum as a target. @@ -126,12 +126,12 @@ The summary file primarily contains two mappings: This currently means that it grows linearly with both items. On the other hand, using the summary file, a client can enumerate branches. -Further, the summary file is fetched over e.g. pinned TLS, this -creates a strong end-to-end verification of the commit or static delta. +Further, fetching the summary file over e.g. pinned TLS creates a strong +end-to-end verification of the commit or static delta. -The summary file can also be GPG signed (detached), and currently this -is the only way provide GPG signatures (transitively) on deltas. +The summary file can also be GPG signed (detached). This is currently +the only way to provide GPG signatures (transitively) on deltas. If a repository administrator creates a summary file, they must -thereafter run `ostree summary -u` to update it whenever a commit is -made or a static delta is generated. +thereafter run `ostree summary -u` to update it whenever a ref is +updated or a static delta is generated.