Document repo-update

tingping/wmclass
Matthias Clasen 2015-01-24 21:53:51 -05:00
parent dfde6c46b8
commit 29151659ae
4 changed files with 113 additions and 3 deletions

View File

@ -31,6 +31,7 @@ man_MANS = \
xdg-app-build.1 \
xdg-app-build-finish.1 \
xdg-app-build-export.1 \
xdg-app-repo-contents.1 \
$(NULL)
xml_files = $(man_MANS:.1=.xml)

View File

@ -66,9 +66,8 @@
in the commit, anything else is ignored.
</para>
<para>
After this command, <arg choice="plain">LOCATION</arg> can be
used as the repository location for xdg-app add-repo, either by
exporting it over http, or directly with a file: url.
The repo-update command should be used to update repository
metadata whenever application builds are added to a repository.
</para>
</refsect1>
@ -150,6 +149,7 @@ Content Bytes Written: 305
<citerefentry><refentrytitle>xdg-app-build-init</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-build</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-build-finish</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>xdg-app-repo-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>

View File

@ -0,0 +1,102 @@
<?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">
<refentry id="xdg-app-repo-update">
<refentryinfo>
<title>xdg-app repo-update</title>
<productname>xdg-app</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Alexander</firstname>
<surname>Larsson</surname>
<email>alexl@redhat.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>xdg-app repo-update</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>xdg-app-repo-update</refname>
<refpurpose>Create a repository from a build directory</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>xdg-app repo-update</command>
<arg choice="opt" rep="repeat">OPTION</arg>
<arg choice="plain">LOCATION</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Updates repository metadata for the repository at
<arg choice="plain">LOCATION</arg>. This command generates
an OSTree summary file that lists the contents of the repository.
The summary is used by xdg-app repo-contents and other commands
to display the contents of remote repositories.
</para>
<para>
After this command, <arg choice="plain">LOCATION</arg> can be
used as the repository location for xdg-app add-repo, either by
exporting it over http, or directly with a file: url.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem><para>
Show help options and exit.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<term><option>--verbose</option></term>
<listitem><para>
Print debug information during command processing.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem><para>
Print version information and exit.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See also</title>
<para>
<citerefentry><refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-repo-contents</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>xdg-app-build-export</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>

View File

@ -245,6 +245,13 @@
Create a repository from a build directory.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>xdg-app-repo-contents</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>
Update repository metadata.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>