From 999f9a2b2de35c89d500badc288f2237c1bfedc2 Mon Sep 17 00:00:00 2001 From: Stefan Agner Date: Fri, 31 Jul 2020 11:49:38 +0200 Subject: [PATCH] man: add glossary to main man page Add glossary to define some commonly used literals throughout the ostree man pages. Signed-off-by: Stefan Agner --- man/ostree.xml | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/man/ostree.xml b/man/ostree.xml index 8c08bae6..e280a024 100644 --- a/man/ostree.xml +++ b/man/ostree.xml @@ -483,6 +483,70 @@ Boston, MA 02111-1307, USA. + + Terminology + + The following terms are commonly used throughout the man pages. Terms in upper case letters + are literals used in command line arguments. + + + BRANCH + + + Branch name. Part of a REF. + + + + CHECKSUM + + + A SHA256 hash of a object stored in the OSTree repository. This can be a content, + a dirtree, a dirmeta or a commit object. If the SHA256 hash of a commit object is + meant, the term COMMIT is used. + + + + COMMIT + + + A SHA256 hash of a commit object. + + + + REF + + + A reference to a particular commit. References are text files stored in + refs/ that name (refer to) a particular commit. A + reference can only be the branch name part, in which case a local reference + is used (e.g. mybranch/stable). If a remote branch + is referred to, the remote name followed by a colon and the branch name + needs to be used (e.g. myremote:mybranch/stable). + + + + REV REFSPEC + + + A specific revision, a commit. This can be anything which can be resolved to a + commit, e.g. a REF or a + COMMIT. + + + + SHA256 + + + A cryptographic hash function used to store objects in the OSTree + repository. The hashes have a length of 256 bites and are typically + shown and passed to ostree in its 64 ASCII character long hexadecimal + representation + (e.g. 0fc70ed33cfd7d26fe99ae29afb7682ddd0e2157a4898bd8cfcdc8a03565b870). + + + + + See Also