packaging
/
ostree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

man: Update ostree-summary.xml 

Update the man page for the summary command to add the undocumented
options, make the syntax clear, and add examples.

Closes: #1416
Approved by: pwithnall
This commit is contained in:
Matthew Leeds 2018-01-12 22:22:50 -08:00 committed by Atomic Bot
parent 52dd4f282c
commit 792b32eb96
1 changed files with 57 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
man/ostree-summary.xml
View File

@ -44,12 +44,16 @@ Boston, MA 02111-1307, USA.
<refnamediv>
<refname>ostree-summary</refname>
<refpurpose>Regenerate the summary metadata file</refpurpose>
<refpurpose>Regenerate or view the summary metadata file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
<command>ostree summary</command> <arg choice="opt">--gpg-sign=KEYID</arg> <arg choice="opt">--gpg-homedir=HOMEDIR</arg> <arg choice="req">--update</arg> <arg choice="opt" rep="repeat">--add-metadata=<replaceable>KEY</replaceable>=<replaceable>VALUE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree summary</command> <group choice="req"><arg choice="plain">--view</arg><arg choice="plain">--raw</arg></group>
</cmdsynopsis>
</refsynopsisdiv>
@ -70,19 +74,12 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><option>-u</option></term>
<term><option>--update</option>,<option>-u</option></term>
<listitem><para>
Update the summary file.
</para><para>
Any additional arguments to the command
are treated as additional key–value pairs to be added to the
summary file as additional metadata. They must be in the format
<command><replaceable>KEY</replaceable>=<replaceable>VALUE</replaceable></command>
or as two separate arguments. The keys must be namespaced for
your organisation or repository using a dot prefix. The values
must be in GVariant text format. For example,
<command>exampleos.end-of-life "@t 1445385600"</command>.
Update the summary file. This option can be combined
with <option>--add-metadata</option> to add metadata
fields to the summary.
</para>
<!-- FIXME: Uncomment this when collection ID support becomes non-experimental.
@ -95,6 +92,37 @@ Boston, MA 02111-1307, USA.
</listitem>
</varlistentry>
<varlistentry>
<term><option>--add-metadata</option>,<option>-m</option>=KEY=VALUE</term>
<listitem><para>
Specify an additional metadata field to add to the summary.
It must be in the format
<command><replaceable>KEY</replaceable>=<replaceable>VALUE</replaceable></command>
or as two separate arguments. The keys must be namespaced
for your organisation or repository using a dot prefix. The
values must be in GVariant text format. For example,
<command>exampleos.end-of-life "@t 1445385600"</command>.
This option can be used multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--view</option>,<option>-v</option></term>
<listitem><para>
View the contents of the summary file in a human readable format.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--raw</option></term>
<listitem><para>
View the raw bytes of the summary file.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--gpg-sign</option>=KEYID</term>
@ -113,4 +141,19 @@ Boston, MA 02111-1307, USA.
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para><command>$ ostree summary -u</command></para>
<para><command>$ ostree summary -u -m key="'value'"</command></para>
<para><command>$ ostree summary -v</command></para>
<programlisting>
* ostree/1/1/0
Latest Commit (4.2 MB):
9828ab80f357459b4ab50f0629beab2ae3b67318fc3d161d10a89fae353afa90
Timestamp (ostree.commit.timestamp): 2017-11-21T01:41:10-08
Last-Modified (ostree.summary.last-modified): 2018-01-12T22:06:38-08
</programlisting>
</refsect1>
</refentry>