summaryrefslogtreecommitdiff
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
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
-rw-r--r--man/ostree-pull.xml7
-rw-r--r--src/libostree/ostree-repo.h2
-rw-r--r--src/ostree/ot-builtin-pull.c2
3 files changed, 8 insertions, 3 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>
diff --git a/src/libostree/ostree-repo.h b/src/libostree/ostree-repo.h
index 8766e6df..ab1aa0b3 100644
--- a/src/libostree/ostree-repo.h
+++ b/src/libostree/ostree-repo.h
@@ -1081,7 +1081,7 @@ gboolean ostree_repo_prune_from_reachable (OstreeRepo *self,
/**
* OstreeRepoPullFlags:
* @OSTREE_REPO_PULL_FLAGS_NONE: No special options for pull
- * @OSTREE_REPO_PULL_FLAGS_MIRROR: Write out refs suitable for mirrors
+ * @OSTREE_REPO_PULL_FLAGS_MIRROR: Write out refs suitable for mirrors and fetch all refs if none requested
* @OSTREE_REPO_PULL_FLAGS_COMMIT_ONLY: Fetch only the commit metadata
* @OSTREE_REPO_PULL_FLAGS_UNTRUSTED: Don't trust local remote
* @OSTREE_REPO_PULL_FLAGS_BAREUSERONLY_FILES: Since 2017.7. Reject writes of content objects with modes outside of 0775.
diff --git a/src/ostree/ot-builtin-pull.c b/src/ostree/ot-builtin-pull.c
index eceddb0f..ebcde49d 100644
--- a/src/ostree/ot-builtin-pull.c
+++ b/src/ostree/ot-builtin-pull.c
@@ -55,7 +55,7 @@ static GOptionEntry options[] = {
{ "disable-fsync", 0, 0, G_OPTION_ARG_NONE, &opt_disable_fsync, "Do not invoke fsync()", NULL },
{ "disable-static-deltas", 0, 0, G_OPTION_ARG_NONE, &opt_disable_static_deltas, "Do not use static deltas", NULL },
{ "require-static-deltas", 0, 0, G_OPTION_ARG_NONE, &opt_require_static_deltas, "Require static deltas", NULL },
- { "mirror", 0, 0, G_OPTION_ARG_NONE, &opt_mirror, "Write refs suitable for a mirror", NULL },
+ { "mirror", 0, 0, G_OPTION_ARG_NONE, &opt_mirror, "Write refs suitable for a mirror and fetches all refs if none provided", NULL },
{ "subpath", 0, 0, G_OPTION_ARG_FILENAME_ARRAY, &opt_subpaths, "Only pull the provided subpath(s)", NULL },
{ "untrusted", 0, 0, G_OPTION_ARG_NONE, &opt_untrusted, "Do not trust (local) sources", NULL },
{ "bareuseronly-files", 0, 0, G_OPTION_ARG_NONE, &opt_bareuseronly_files, "Reject regular files with mode outside of 0775 (world writable, suid, etc.)", NULL },