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

commit: Update manpage to reflect --editor 

Closes: #305
Approved by: cgwalters
This commit is contained in:
Mathnerd314 2016-05-23 13:32:36 -06:00 committed by Atomic Bot
parent c82f15201a
commit 6bf94ec233
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
man/ostree-commit.xml
View File

@ -57,7 +57,7 @@ Boston, MA 02111-1307, USA.
<title>Description</title> <title>Description</title>
<para> <para>
This allows you to commit changes to a branch. The specification of the branch is required. If no commit message is specified with <option>--subject</option> then a text editor will be opened. The commit will be aborted if the commit subject is left empty. The command will print the checksum of a successful commit. This allows you to commit changes to a branch. The specification of the branch is required. The command will print the checksum of a successful commit.
</para> </para>
</refsect1> </refsect1>
@ -68,7 +68,7 @@ Boston, MA 02111-1307, USA.
<term><option>--subject</option>, <option>-s</option>="SUBJECT"</term> <term><option>--subject</option>, <option>-s</option>="SUBJECT"</term>
<listitem><para> <listitem><para>
One line subject. One line subject. (optional)
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
@ -76,7 +76,15 @@ Boston, MA 02111-1307, USA.
<term><option>--body</option>, <option>-m</option>="BODY"</term> <term><option>--body</option>, <option>-m</option>="BODY"</term>
<listitem><para> <listitem><para>
Full description. Full description. (optional)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--editor</option>, <option>-e</option></term>
<listitem><para>
Open a text editor for the commit description. It will use OSTREE_EDITOR, VISUAL, EDITOR, or vi, in descending order of preference. The commit will be aborted if the message is left empty.
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
@ -84,7 +92,7 @@ Boston, MA 02111-1307, USA.
<term><option>--branch</option>, <option>-b</option>="BRANCH"</term> <term><option>--branch</option>, <option>-b</option>="BRANCH"</term>
<listitem><para> <listitem><para>
Branch. Branch. Required, unless --orphan is given.
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
@ -219,7 +227,7 @@ Boston, MA 02111-1307, USA.
<term><option>--orphan</option></term> <term><option>--orphan</option></term>
<listitem><para> <listitem><para>
Create a commit without writing a ref Create a commit without writing to a ref (branch)
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>