diff options
author | Alexander Larsson <alexl@redhat.com> | 2016-04-13 10:08:59 +0200 |
---|---|---|
committer | Alexander Larsson <alexl@redhat.com> | 2016-04-13 10:08:59 +0200 |
commit | eb3a0df75c869745232daee29e50f9bb0713a5ee (patch) | |
tree | 5dd027772c95e4e911265d3df72140b74cb93780 /doc | |
parent | 51781b50d27bed289553b4e562dee41ada9c36b0 (diff) | |
download | xdg-app-eb3a0df75c869745232daee29e50f9bb0713a5ee.tar.gz |
Add xdg-app build-sign to sign a single commit
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 1 | ||||
-rw-r--r-- | doc/xdg-app-build-export.xml | 1 | ||||
-rw-r--r-- | doc/xdg-app-build-sign.xml | 154 | ||||
-rw-r--r-- | doc/xdg-app.xml | 7 |
4 files changed, 163 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 01f84be..fa641ea 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -37,6 +37,7 @@ man_MANS = \ xdg-app-build-finish.1 \ xdg-app-build-export.1 \ xdg-app-build-update-repo.1 \ + xdg-app-build-sign.1 \ xdg-app-builder.1 \ $(NULL) diff --git a/doc/xdg-app-build-export.xml b/doc/xdg-app-build-export.xml index 02f0543..155d014 100644 --- a/doc/xdg-app-build-export.xml +++ b/doc/xdg-app-build-export.xml @@ -215,6 +215,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-build-sign</refentrytitle><manvolnum>1</manvolnum></citerefentry> <citerefentry><refentrytitle>xdg-app-repo-update</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> diff --git a/doc/xdg-app-build-sign.xml b/doc/xdg-app-build-sign.xml new file mode 100644 index 0000000..4a6a5e3 --- /dev/null +++ b/doc/xdg-app-build-sign.xml @@ -0,0 +1,154 @@ +<?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-build-export"> + + <refentryinfo> + <title>xdg-app build-sign</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 build-sign</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>xdg-app-build-sign</refname> + <refpurpose>Sign an application or runtime</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>xdg-app build-sign</command> + <arg choice="opt" rep="repeat">OPTION</arg> + <arg choice="plain">LOCATION</arg> + <arg choice="plain">ID</arg> + <arg choice="opt">BRANCH</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + Signs the commit for a speficied application or runtime in + a local repository. <arg choice="plain">LOCATION</arg> is + the location of the repository. <arg + choice="plain">ID</arg> is the name of the application, or + runtime if --runtime is specified. If <arg + choice="plain">BRANCH</arg> is not specified, it is + assumed to be "master". + </para> + <para> + Applications can also be signed during build-export, but + it is sometimes useful to add additionaly signatures later. + </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>--gpg-sign=KEYID</option></term> + + <listitem><para> + Sign the commit with this GPG key + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--gpg-homedir=PATH</option></term> + + <listitem><para> + GPG Homedir to use when looking for keyrings + </para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--runtime</option></term> + + <listitem><para> + Sign a runtime instead of an app. + </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 build-export ~/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> + + <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-build-export</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>xdg-app-build</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + </para> + + </refsect1> + +</refentry> diff --git a/doc/xdg-app.xml b/doc/xdg-app.xml index 48df894..d48613f 100644 --- a/doc/xdg-app.xml +++ b/doc/xdg-app.xml @@ -262,6 +262,13 @@ Update the summary file in a repository. </para></listitem> </varlistentry> + <varlistentry> + <term><citerefentry><refentrytitle>xdg-app-build-sign</refentrytitle><manvolnum>1</manvolnum></citerefentry></term> + + <listitem><para> + Sign an application or runtime after its been exported. + </para></listitem> + </varlistentry> </variablelist> </refsect1> |