mirror of
https://github.com/ostreedev/ostree.git
synced 2024-12-22 17:35:55 +03:00
feeb3548f4
This is the new way of publishing repository metadata, rather than as additional-metadata in the summary file. The use of an ostree-metadata ref means that the metadata from multiple upstream collections is not conflated when doing P2P mirroring of many repositories. The new ref is only generated if the repository has a collection ID set. The old summary file continues to be generated for backwards compatibility (and because it continues to be the canonical ref → checksum map for the repository). The new code is only used if configured with --enable-experimental-api. Includes unit tests. Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #1158 Approved by: cgwalters
117 lines
4.0 KiB
XML
117 lines
4.0 KiB
XML
<?xml version='1.0'?> <!--*-nxml-*-->
|
||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||
|
||
<!--
|
||
Copyright 2014 Colin Walters <walters@verbum.org>
|
||
|
||
This library is free software; you can redistribute it and/or
|
||
modify it under the terms of the GNU Lesser General Public
|
||
License as published by the Free Software Foundation; either
|
||
version 2 of the License, or (at your option) any later version.
|
||
|
||
This library is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
Lesser General Public License for more details.
|
||
|
||
You should have received a copy of the GNU Lesser General Public
|
||
License along with this library; if not, write to the
|
||
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
||
Boston, MA 02111-1307, USA.
|
||
-->
|
||
|
||
<refentry id="ostree">
|
||
|
||
<refentryinfo>
|
||
<title>ostree summary</title>
|
||
<productname>OSTree</productname>
|
||
|
||
<authorgroup>
|
||
<author>
|
||
<contrib>Developer</contrib>
|
||
<firstname>Colin</firstname>
|
||
<surname>Walters</surname>
|
||
<email>walters@verbum.org</email>
|
||
</author>
|
||
</authorgroup>
|
||
</refentryinfo>
|
||
|
||
<refmeta>
|
||
<refentrytitle>ostree summary</refentrytitle>
|
||
<manvolnum>1</manvolnum>
|
||
</refmeta>
|
||
|
||
<refnamediv>
|
||
<refname>ostree-summary</refname>
|
||
<refpurpose>Regenerate the summary metadata file</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsynopsisdiv>
|
||
<cmdsynopsis>
|
||
<command>ostree summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
|
||
</cmdsynopsis>
|
||
</refsynopsisdiv>
|
||
|
||
<refsect1>
|
||
<title>Description</title>
|
||
|
||
<para>
|
||
The <filename>summary</filename> file is an optional higher
|
||
level form of repository metadata that describes the
|
||
available branches. It needs to be manually regenerated after
|
||
a series of commits. Among other things, this allows atomically
|
||
updating multiple commits.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1>
|
||
<title>Options</title>
|
||
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><option>-u</option></term>
|
||
|
||
<listitem><para>
|
||
Update the summary file.
|
||
</para><para>
|
||
Any additional arguments to the command
|
||
are treated as additional key–value pairs to be added to the
|
||
summary file as additional metadata. They must be in the format
|
||
<command><replaceable>KEY</replaceable>=<replaceable>VALUE</replaceable></command>
|
||
or as two separate arguments. The keys must be namespaced for
|
||
your organisation or repository using a dot prefix. The values
|
||
must be in GVariant text format. For example,
|
||
<command>exampleos.end-of-life "@t 1445385600"</command>.
|
||
</para>
|
||
|
||
<!-- FIXME: Uncomment this when collection ID support becomes non-experimental.
|
||
<para>If the repository has a collection ID configured, the
|
||
<filename>ostree-metadata</filename> branch for that collection ID
|
||
will also be updated with a new commit containing the given metadata,
|
||
which will be signed if the summary file is signed.</para>
|
||
-->
|
||
|
||
</listitem>
|
||
</varlistentry>
|
||
|
||
<varlistentry>
|
||
<term><option>--gpg-sign</option>=KEYID</term>
|
||
|
||
<listitem><para>
|
||
GPG Key ID to sign the summary with.
|
||
</para></listitem>
|
||
</varlistentry>
|
||
|
||
<varlistentry>
|
||
<term><option>--gpg-homedir</option>=HOMEDIR</term>
|
||
|
||
<listitem><para>
|
||
GPG Homedir to use when looking for keyrings.
|
||
</para></listitem>
|
||
</varlistentry>
|
||
|
||
</variablelist>
|
||
</refsect1>
|
||
</refentry>
|