forked from Mirrors/flatpak-builder
Document the make-repo command
Matthias Clasen
parent
23baa46371
commit
067e95fcfd
|
|
@ -27,6 +27,7 @@ man_MANS = \
|
|||
xdg-app-build-init.1 \
|
||||
xdg-app-build.1 \
|
||||
xdg-app-build-finish.1 \
|
||||
xdg-app-make-repo.1 \
|
||||
$(NULL)
|
||||
|
||||
xml_files = $(man_MANS:.1=.xml)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,130 @@
|
|||
<?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-make-repo">
|
||||
|
||||
<refentryinfo>
|
||||
<title>dxg-app make-repo</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 make-repo</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>xdg-app-make-repo</refname>
|
||||
<refpurpose>Finalize a build directory</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>xdg-app make-repo</command>
|
||||
<arg choice="opt" rep="repeat">OPTION</arg>
|
||||
<arg choice="plain">REPO</arg>
|
||||
<arg choice="plain">DIRECTORY</arg>
|
||||
<arg choice="plain">NAME</arg>
|
||||
<arg choice="opt">BRANCH</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para>
|
||||
Creates or updates a repository with an application build.
|
||||
<arg choice="plain">REPO</arg> is the location of the
|
||||
repository. <arg choice="plain">DIRECTORY</arg> must be a
|
||||
finalized build directory. <arg choice="plain">NAME</arg>
|
||||
is the name of the application. If <arg choice="plain">BRANCH</arg>
|
||||
is not specified, it is assumed to be "master".
|
||||
</para>
|
||||
<para>
|
||||
If <arg choice="plain">REPO</arg> exists, it is assumed to
|
||||
be an OSTree repository, otherwise a new repository is created
|
||||
at this location.
|
||||
</para>
|
||||
<para>
|
||||
The contents of <arg choice="plain">DIRECTORY</arg> are committed
|
||||
on the branch with name <literal>app/NAME/ARCH/BRANCH</literal>,
|
||||
where ARCH is the architecture of the host system unless overridden
|
||||
by the <option>--arch</option> option.
|
||||
</para>
|
||||
<para>
|
||||
After this command, <arg choice="plain">REPO</arg> can be
|
||||
used as the repository location for xdg-app add-repo,
|
||||
either by exporting it over http, or directly as 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>--arch=ARCH</option></term>
|
||||
|
||||
<listitem><para>
|
||||
The architecture to use.
|
||||
</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>Examples</title>
|
||||
|
||||
<para>
|
||||
<command>$ xdg-app make-repo ~/repos/gnome-calculator/ ~/build/gnome-calculator/ org.gnome.Calculator</command>
|
||||
</para>
|
||||
<programlisting>
|
||||
Commit: 9d0044ea480297114d03aec85c3d7ae3779438f9d2cb69d717fb54237acacb8c
|
||||
Metadata Total: 605
|
||||
Metadata Written: 5
|
||||
Content Total: 1174
|
||||
Content Written: 1
|
||||
Content Bytes Written: 305
|
||||
</programlisting>
|
||||
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
|
@ -179,6 +179,13 @@
|
|||
Finalizes a build directory.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><citerefentry><refentrytitle>make-repo</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
|
||||
|
||||
<listitem><para>
|
||||
Create a repository from a build directory.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue