summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJonathan Lebon <jlebon@redhat.com>2017-08-21 16:52:59 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2017-08-23 01:23:38 +0000
commit11fdca291950771858872386560e1103df1dda5f (patch)
tree049427264b03d2a662e49b9b440bf3c56ad3c2e3 /man
parent80eab25f8ad367ba7f391a89558ef90eb69ce232 (diff)
downloadostree-11fdca291950771858872386560e1103df1dda5f.tar.gz
pull: better description for --mirror
Describe the behaviour of --mirror a bit better. Closes: #1100 Closes: #1099 Approved by: dustymabe
Diffstat (limited to 'man')
-rw-r--r--man/ostree-pull.xml7
1 files changed, 6 insertions, 1 deletions
diff --git a/man/ostree-pull.xml b/man/ostree-pull.xml
index 59a6dbc8..9c970714 100644
--- a/man/ostree-pull.xml
+++ b/man/ostree-pull.xml
@@ -103,7 +103,12 @@ Boston, MA 02111-1307, USA.
<term><option>--mirror</option></term>
<listitem><para>
- Write refs suitable for a mirror.
+ Write refs suitable for a mirror, i.e. refs are stored in the
+ <literal>heads/</literal> directory rather than the
+ <literal>remotes/</literal> directory. This makes the target repo
+ suitable to be exported for other clients to pull from as an ostree
+ remote. If no specific refs are specified, all refs will be fetched (the
+ remote must have a summary file present).
</para></listitem>
</varlistentry>