diff options
author | Colin Walters <walters@verbum.org> | 2014-09-07 17:41:12 -0400 |
---|---|---|
committer | Colin Walters <walters@verbum.org> | 2014-09-07 17:41:12 -0400 |
commit | afab8e2ad3f7ce6d40e658c791c0d312e7179c27 (patch) | |
tree | f052b8d7238b480835f003bfeea968d538803180 | |
parent | b30f32e0da051b4b960c57a56278728eb7124af6 (diff) | |
download | ostree-afab8e2ad3f7ce6d40e658c791c0d312e7179c27.tar.gz |
doc: Add a man page for summary command
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/ostree-summary.xml | 81 | ||||
-rw-r--r-- | doc/ostree.xml | 8 |
3 files changed, 90 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 228de4f3..734937f6 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -108,7 +108,7 @@ include $(top_srcdir)/gtk-doc.make man1_MANS = if ENABLE_GTK_DOC -man1_MANS += ostree.1 ostree.repo.5 ostree.repo-config.5 ostree-admin-cleanup.1 ostree-admin-config-diff.1 ostree-admin-deploy.1 ostree-admin-init-fs.1 ostree-admin-instutil.1 ostree-admin-os-init.1 ostree-admin-status.1 ostree-admin-switch.1 ostree-admin-undeploy.1 ostree-admin-upgrade.1 ostree-admin.1 ostree-cat.1 ostree-checkout.1 ostree-checksum.1 ostree-commit.1 ostree-config.1 ostree-diff.1 ostree-fsck.1 ostree-init.1 ostree-log.1 ostree-ls.1 ostree-prune.1 ostree-pull-local.1 ostree-pull.1 ostree-refs.1 ostree-remote.1 ostree-reset.1 ostree-rev-parse.1 ostree-show.1 ostree-static-delta.1 ostree-trivial-httpd.1 +man1_MANS += ostree.1 ostree.repo.5 ostree.repo-config.5 ostree-admin-cleanup.1 ostree-admin-config-diff.1 ostree-admin-deploy.1 ostree-admin-init-fs.1 ostree-admin-instutil.1 ostree-admin-os-init.1 ostree-admin-status.1 ostree-admin-switch.1 ostree-admin-undeploy.1 ostree-admin-upgrade.1 ostree-admin.1 ostree-cat.1 ostree-checkout.1 ostree-checksum.1 ostree-commit.1 ostree-config.1 ostree-diff.1 ostree-fsck.1 ostree-init.1 ostree-log.1 ostree-ls.1 ostree-prune.1 ostree-pull-local.1 ostree-pull.1 ostree-refs.1 ostree-remote.1 ostree-reset.1 ostree-rev-parse.1 ostree-show.1 ostree-summary.1 ostree-static-delta.1 ostree-trivial-httpd.1 XSLTPROC_FLAGS = \ diff --git a/doc/ostree-summary.xml b/doc/ostree-summary.xml new file mode 100644 index 00000000..f19074fc --- /dev/null +++ b/doc/ostree-summary.xml @@ -0,0 +1,81 @@ +<?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 <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </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></listitem> + </varlistentry> + </variablelist> + </refsect1> +</refentry> diff --git a/doc/ostree.xml b/doc/ostree.xml index 00ca7f74..5a93be69 100644 --- a/doc/ostree.xml +++ b/doc/ostree.xml @@ -385,6 +385,14 @@ Boston, MA 02111-1307, USA. </varlistentry> <varlistentry> + <citerefentry><refentrytitle>ostree-summary</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + <listitem><para> + Regenerate the repository summary metadata. + </para></listitem> + </varlistentry> + + <varlistentry> <citerefentry><refentrytitle>ostree-trivial-httpd</refentrytitle><manvolnum>1</manvolnum></citerefentry> <listitem><para> |