man/ostree-init: Briefly describe various modes

Closes: #1561

Closes: #1560
Approved by: cgwalters
This commit is contained in:
Jonathan Lebon 2018-04-30 09:42:11 -04:00 committed by Atomic Bot
parent 54c5ab76a9
commit a85f06952d
2 changed files with 19 additions and 8 deletions

View File

@ -69,13 +69,24 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><option>--mode</option>="MODE"</term>
<listitem><para> Initialize repository in given mode
(<literal>bare</literal>, <literal>bare-user</literal>,
<literal>archive</literal>). The default is
<literal>bare</literal>. Note that for
<literal>archive</literal> the repository configuration file
will actually have <literal>archive-z2</literal>, as that's the
historical name.</para></listitem>
<listitem><para>
Initialize repository in given mode
(<literal>bare</literal>, <literal>bare-user</literal>,
<literal>bare-user-only</literal>, <literal>archive</literal>).
The default is <literal>bare</literal>. Note that for
<literal>archive</literal> the repository configuration file
will actually have <literal>archive-z2</literal>, as that's
the historical name.</para>
<para>See the manual for differences between these modes.
Briefly, <literal>bare</literal> mode stores files as they
are, so they can be directly hardlinked,
<literal>bare-user</literal> uses extended attributes to
store ownership and xattr information, allowing non-root
operations, <literal>bare-user-only</literal> does not store
ownership information, and <literal>archive</literal> stores
files compressed, to be served over the network.
</para></listitem>
</varlistentry>
<varlistentry>

View File

@ -38,7 +38,7 @@ static char *opt_collection_id = NULL;
*/
static GOptionEntry options[] = {
{ "mode", 0, 0, G_OPTION_ARG_STRING, &opt_mode, "Initialize repository in given mode (bare, archive)", NULL },
{ "mode", 0, 0, G_OPTION_ARG_STRING, &opt_mode, "Initialize repository in given mode (bare, bare-user, bare-user-only, archive)", NULL },
#ifdef OSTREE_ENABLE_EXPERIMENTAL_API
{ "collection-id", 0, 0, G_OPTION_ARG_STRING, &opt_collection_id,
"Globally unique ID for this repository as an collection of refs for redistribution to other repositories", "COLLECTION-ID" },