summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Lebon <jlebon@redhat.com>2017-08-10 09:05:15 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2017-08-10 14:54:03 +0000
commitd3a5d26176c88903f47a21f31b4154abd7631694 (patch)
tree2d700c3e6f7f1dbbc70af285447826769365fba6
parent95c832b4e22dab7a26d815ee8e94e04f733bd66d (diff)
downloadostree-d3a5d26176c88903f47a21f31b4154abd7631694.tar.gz
man: document configured branches
Closes: #1072 Closes: #1073 Approved by: guyshapiro
-rw-r--r--man/ostree-pull.xml2
-rw-r--r--man/ostree-remote.xml7
-rw-r--r--man/ostree.repo-config.xml7
3 files changed, 15 insertions, 1 deletions
diff --git a/man/ostree-pull.xml b/man/ostree-pull.xml
index dd901aa2..d7831850 100644
--- a/man/ostree-pull.xml
+++ b/man/ostree-pull.xml
@@ -132,7 +132,7 @@ Boston, MA 02111-1307, USA.
This command can retrieve just a specific commit, or go all
the way to performing a full mirror of the remote
repository. If no <literal>BRANCH</literal> is specified,
- all branches are retrieved.
+ all configured branches are retrieved.
</para>
<para>
diff --git a/man/ostree-remote.xml b/man/ostree-remote.xml
index 2bb8aa71..bf41a10c 100644
--- a/man/ostree-remote.xml
+++ b/man/ostree-remote.xml
@@ -97,6 +97,13 @@ Boston, MA 02111-1307, USA.
Changes remote repository configurations. The NAME refers to the name of the remote.
</para>
<para>
+ The <literal>BRANCH</literal> arguments to the
+ <command>add</command> subcommand specifies the configured branches
+ for the remote. See the <literal>branches</literal> section in
+ <citerefentry><refentrytitle>ostree.repo-config</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ for more information.
+ </para>
+ <para>
The <command>gpg-import</command> subcommand can associate GPG keys to a specific remote repository for use when pulling signed commits from that repository (if GPG verification is enabled).
</para>
<para>
diff --git a/man/ostree.repo-config.xml b/man/ostree.repo-config.xml
index 90d0f3dc..cf0bf7c0 100644
--- a/man/ostree.repo-config.xml
+++ b/man/ostree.repo-config.xml
@@ -148,6 +148,13 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
+ <term><varname>branches</varname></term>
+ <listitem><para>A list of strings. Represents the default configured
+ branches to fetch from the remote when no specific branches are
+ requested during a pull operation.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><varname>proxy</varname></term>
<listitem><para>A string value, if given should be a URL for a
HTTP proxy to use for access to this repository.</para></listitem>