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

man: Update ostree-refs manpage 

Update the ostree-refs manpage to document recently added options, and
fix some minor mistakes.

Closes: #1068
Approved by: cgwalters
This commit is contained in:
Matthew Leeds 2017-08-08 14:55:23 -07:00 committed by Atomic Bot
parent de153dea30
commit 6c7a6519dd
1 changed files with 25 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
man/ostree-refs.xml
View File

@ -51,13 +51,17 @@ Boston, MA 02111-1307, USA.
<cmdsynopsis> <cmdsynopsis>
<command>ostree refs</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">PREFIX</arg> <command>ostree refs</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">PREFIX</arg>
</cmdsynopsis> </cmdsynopsis>
<cmdsynopsis>
<command>ostree refs</command> <arg choice="req">EXISTING</arg> <arg choice="req">--create=NEWREF</arg>
</cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<!-- Could this be more specific? What defines a "ref"? etc --> <!-- Could this be more specific? What defines a "ref"? etc -->
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<para> <para>
Lists all refs available on the host. If specified, PREFIX assigns the refspec prefix; default prefix is null, which lists all refs. Lists all refs available on the host. If specified, PREFIX assigns the refspec prefix; default
prefix is null, which lists all refs. This command can also be used to create or delete refs.
</para> </para>
</refsect1> </refsect1>
@ -75,6 +79,16 @@ Boston, MA 02111-1307, USA.
printed in full, rather than printed in full, rather than
truncated. </para></listitem> truncated. </para></listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--create</option>=NEWREF</term>
<listitem><para>
Create a ref pointing to the commit EXISTING. NEWREF must not already exist, and EXISTING
must be an existing commit. More than one ref can point to the same commit.
</para></listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--delete</option></term> <term><option>--delete</option></term>
@ -85,7 +99,15 @@ Boston, MA 02111-1307, USA.
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--collections</option></term> <term><option>--alias</option>, <option>-A</option></term>
<listitem><para>
If used with <option>--create</option>, create an alias. Otherwise just list aliases.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--collections</option>, <option>-c</option></term>
<listitem><para> <listitem><para>
Enable interactions with refs using the combination of their Enable interactions with refs using the combination of their
@ -99,8 +121,7 @@ Boston, MA 02111-1307, USA.
is created. (This is an abuse of the refspec syntax.)</para> is created. (This is an abuse of the refspec syntax.)</para>
<para>When deleting refs, all refs whose collection ID equals <para>When deleting refs, all refs whose collection ID equals
the value of the <option>--delete</option> argument are PREFIX are deleted.
deleted.
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>