packaging/ostree
1
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Various manpage / usage blurb improvements

Browse Source 
Corrections, clarifications, consistency.

Not a comprehensive overhaul of the manpages; they do still need work.
These are just flaws I've noted while studying the ostree command syntax.

https://bugzilla.gnome.org/show_bug.cgi?id=740097
This commit is contained in:
Matthew Barnes committed 2014-11-16 15:52:51 -05:00
1 parent f699153f67
commit 3a9127f103
23 files changed
+69 -61
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/ostree-admin-config-diff.xml
+1 -1
View File
@@ -69,7 +69,7 @@ Boston, MA 02111-1307, USA.
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
If provided, specifies the operating system root. Default is the current one.
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
</variablelist>
doc/ostree-admin-deploy.xml
+3 -3
View File
@@ -69,7 +69,7 @@ Boston, MA 02111-1307, USA.
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
If provided, specifies the operating system root. Default is the current one.
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
@@ -98,7 +98,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--karg</option>="KEY=VALUE"</term>
<term><option>--karg</option>="NAME=VALUE"</term>
<listitem><para>
Set kernel argument, like root=/dev/sda1; this overrides any earlier argument with the same name.
@@ -106,7 +106,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--karg-append</option>="KEY=VALUE"</term>
<term><option>--karg-append</option>="NAME=VALUE"</term>
<listitem><para>
Append kernel argument; useful with e.g. console= that can be used multiple times.
doc/ostree-admin-instutil.xml
+4 -4
View File
@@ -67,21 +67,21 @@ Boston, MA 02111-1307, USA.
<variablelist>
<varlistentry>
<term><command>selinux-ensure-labeled</command></term>
<term><command>selinux-ensure-labeled <arg choice="opt">SUBPATH PREFIX</arg></command></term>
<listitem><para>
Ensure all files and directories are labeled according to SELinux policy of the first deployment. First argument is the subpath and second argument is the prefix.
Ensure all files and directories are labeled according to SELinux policy of the first deployment.
</para></listitem>
</varlistentry>
<varlistentry>
<term><command>set-kargs <arg choice="opt">--merge</arg> <arg choice="opt">--import-proc-cmdline</arg> <arg choice="opt">--append=ARG</arg> <arg choice="opt">--replace=ARG</arg> <arg choice="opt">MORE_APPEND_ARGS</arg></command></term>
<term><command>set-kargs <arg choice="opt">--merge</arg> <arg choice="opt">--import-proc-cmdline</arg> <arg choice="opt">--append="NAME=VALUE"</arg> <arg choice="opt">--replace="NAME=VALUE"</arg> <arg choice="opt">MORE_APPEND_ARGS</arg></command></term>
<listitem><para>
Replace the kernel arguments of the default deployment. The new arguments are based
on an empty list (the default), the current options (--merge), or the arguments
of the loaded kernel (--import-proc-cmdline), and new options either are added to the
end (--append=ARG) or replace existing arguments of the same name (--replace=ARG).
end (--append="NAME=VALUE") or replace existing arguments of the same name (--replace="NAME=VALUE").
</para></listitem>
</varlistentry>
</variablelist>
doc/ostree-admin-switch.xml
+1 -1
View File
@@ -69,7 +69,7 @@ Boston, MA 02111-1307, USA.
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
If provided, specifies the operating system root. Default is the current one.
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
</variablelist>
doc/ostree-admin-upgrade.xml
+1 -1
View File
@@ -69,7 +69,7 @@ Boston, MA 02111-1307, USA.
<term><option>--os</option>="OSNAME"</term>
<listitem><para>
If provided, specifies the operating system root. Default is the current one.
Use a different operating system root than the current one.
</para></listitem>
</varlistentry>
doc/ostree-cat.xml
+1 -1
View File
@@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree cat <arg choice="req">COMMIT</arg> <arg choice="req">PATH</arg> <arg choice="opt">PATH</arg></command>
<command>ostree cat <arg choice="req">COMMIT</arg> <arg choice="req" rep="repeat">PATH</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
doc/ostree-checksum.xml
+1 -1
View File
@@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree checksum <arg choice="req">FILE</arg></command>
<command>ostree checksum <arg choice="req">PATH</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
doc/ostree-commit.xml
+9 -9
View File
@@ -49,7 +49,7 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree commit <arg choice="opt" rep="repeat">OPTIONS</arg> --branch=<arg choice="req">BRANCH</arg> </command>
<command>ostree commit <arg choice="opt" rep="repeat">OPTIONS</arg> --branch=<arg choice="req">BRANCH</arg> <arg choice="opt">PATH</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
@@ -65,7 +65,7 @@ Boston, MA 02111-1307, USA.
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--subject</option>, <option>-s</option>="subject"</term>
<term><option>--subject</option>, <option>-s</option>="SUBJECT"</term>
<listitem><para>
One line subject.
@@ -73,7 +73,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--body</option>, <option>-m</option>="body"</term>
<term><option>--body</option>, <option>-m</option>="BODY"</term>
<listitem><para>
Full description.
@@ -81,7 +81,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--branch</option>, <option>-b</option>="branch"</term>
<term><option>--branch</option>, <option>-b</option>="BRANCH"</term>
<listitem><para>
Branch.
@@ -89,7 +89,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--tree</option>="NAME"</term>
<term><option>--tree</option>="dir=PATH" or "tar=TARFILE" or "ref=COMMIT"</term>
<listitem><para>
Overlay the given argument as a tree.
@@ -100,7 +100,7 @@ Boston, MA 02111-1307, USA.
<term><option>--add-metadata-string</option>="KEY=VALUE"</term>
<listitem><para>
Append given key and value (in string format) to metadata.
Add a key/value pair to metadata.
</para></listitem>
</varlistentry>
@@ -108,7 +108,7 @@ Boston, MA 02111-1307, USA.
<term><option>--add-detached-metadata-string</option>="KEY=VALUE"</term>
<listitem><para>
Append given key and value (in string format) to detached metadata.
Add a key/value pair to detached metadata.
</para></listitem>
</varlistentry>
@@ -184,7 +184,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--gpg-sign</option>="key-id"</term>
<term><option>--gpg-sign</option>="KEY-ID"</term>
<listitem><para>
GPG Key ID with which to sign the commit (if have GPGME - GNU Privacy Guard Made Easy).
@@ -192,7 +192,7 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--gpg-homedir</option>="homedir"</term>
<term><option>--gpg-homedir</option>="HOMEDIR"</term>
<listitem><para>
GPG home directory to use when looking for keyrings (if have GPGME - GNU Privacy Guard Made Easy).
doc/ostree-config.xml
+7 -5
View File
@@ -49,7 +49,10 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree config <arg choice="req">OPERATION</arg> <arg choice="opt">KEY</arg> <arg choice="opt">VALUE</arg></command>
<command>ostree config get <arg choice="req">SECTIONNAME.KEYNAME</arg></command>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree config set <arg choice="req">SECTIONNAME.KEYNAME</arg> <arg choice="req">VALUE</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
@@ -57,14 +60,13 @@ Boston, MA 02111-1307, USA.
<title>Description</title>
<para>
Changes the configuration settings. Possible operations inlclude either "set" or "get". If OPERATION is "set", KEY and VALUE are required. If OPERATION is "get", only KEY is necessary. KEY must be of the form "sectionname.keyname".
Displays or changes a configuration setting.
</para>
</refsect1>
<!-- Need a REAL example here - what is an example of a section name and a key name?-->
<refsect1>
<title>Example</title>
<para><command>$ ostree config get sectionname.keyname</command></para>
keyvalue
<para><command>$ ostree config get core.mode</command></para>
<para>bare</para>
</refsect1>
</refentry>
doc/ostree-remote.xml
+8 -2
View File
@@ -49,7 +49,13 @@ Boston, MA 02111-1307, USA.
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree remote <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">OPERATION</arg> <arg choice="req">NAME</arg> <arg choice="opt">args</arg></command>
<command>ostree remote <arg choice="opt" rep="repeat">OPTIONS</arg> add <arg choice="req">NAME</arg> <arg choice="req">URL</arg> <arg choice="opt" rep="repeat">BRANCH</arg></command>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote delete <arg choice="req">NAME</arg></command>
</cmdsynopsis>
<cmdsynopsis>
<command>ostree remote show-url <arg choice="req">NAME</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
@@ -57,7 +63,7 @@ Boston, MA 02111-1307, USA.
<title>Description</title>
<para>
Changes remote respository configurations. Possible operations include either "add" or "show-url". If OPERATION is "add", a URL must be specified in [args]. The NAME refers to the name of the remote.
Changes remote respository configurations. The NAME refers to the name of the remote.
</para>
</refsect1>
doc/ostree-show.xml
+4 -4
View File
@@ -74,10 +74,10 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
<term><option>--print-variant-type</option>="FILENAME"</term>
<term><option>--print-variant-type</option>="TYPE"</term>
<listitem><para>
Argument should be a filename and it will be interpreted as this type.
Memory map <arg choice="req">OBJECT</arg> (in this case a filename) to the GVariant type string.
</para></listitem>
</varlistentry>
@@ -85,7 +85,7 @@ Boston, MA 02111-1307, USA.
<term><option>--print-metadata-key</option>="KEY"</term>
<listitem><para>
Print string value of metadata key KEY for given commit.
Print string value of metadata key.
</para></listitem>
</varlistentry>
@@ -93,7 +93,7 @@ Boston, MA 02111-1307, USA.
<term><option>--print-detached-metadata-key</option>="KEY"</term>
<listitem><para>
Print string value of detached metadata key KEY for given commit.
Print string value of detached metadata key.
</para></listitem>
</varlistentry>