diff options
| author | Philip Withnall <withnall@endlessm.com> | 2017-06-07 14:51:58 +0100 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2017-06-26 15:56:07 +0000 |
| commit | b7b79fa78d34a34cb75aeca4d0b041586ed74224 (patch) | |
| tree | 8368328c04f933bf725338133028b232351165fa /man | |
| parent | 205a84b36e44808b26ccecbf490e58843548d40c (diff) | |
| download | ostree-b7b79fa78d34a34cb75aeca4d0b041586ed74224.tar.gz | |
refs: Add a --collections argument to the built-in refs command
Rather than change the output format used by the existing refs command
to output collection IDs in addition to ref names, this functionality has
been hidden behind an --collections argument. If it’s not specified `ostree
refs` will output the same content as before for a given repository. If
it is specified, the collection ID for each ref will be included in the
output as (collection ID, ref name).
Signed-off-by: Philip Withnall <withnall@endlessm.com>
Closes: #924
Approved by: cgwalters
Diffstat (limited to 'man')
| -rw-r--r-- | man/ostree-refs.xml | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/man/ostree-refs.xml b/man/ostree-refs.xml index 43e934ff..726a94ac 100644 --- a/man/ostree-refs.xml +++ b/man/ostree-refs.xml @@ -83,6 +83,26 @@ Boston, MA 02111-1307, USA. you will then need to <command>ostree prune</command> or <command>ostree admin cleanup</command>. </para></listitem> </varlistentry> + + <varlistentry> + <term><option>--collections</option></term> + + <listitem><para> + Enable interactions with refs using the combination of their + collection IDs and ref names. When listing refs, this changes + the output format to include collection IDs, and enables + listing remote mirrored refs.</para> + + <para>When creating refs, the refspec value passed to the + <option>--create</option> option is treated as + <literal>COLLECTION-ID:REF-NAME</literal> and a mirrored ref + is created. (This is an abuse of the refspec syntax.)</para> + + <para>When deleting refs, all refs whose collection ID equals + the value of the <option>--delete</option> argument are + deleted. + </para></listitem> + </varlistentry> </variablelist> </refsect1> |