gerrit/Documentation/cmd-kill.txt
Michael Ochmann e2d76a1c23 Fix broken synopsis formatting in documentation
Most of the cmd-xxxx.txt pages were still using the legacy 'italics'
asciidoc [1], which caused the synopsis sections to render like this:

'ssh' -p <port> 'gerrit some-command'

Furthermore, the line breaks and indentations were not rendered.

Replaced the legacy 'italics" with _italics_ in all synopsis sections
and changed the block type to [verse]. Verse blocks preserve indents
and line breaks (like <pre> in HTML), but still allow text formatting.

Fixed also some other minor mistakes and formatting errors.

[1] http://asciidoctor.org/docs/migration/#migration-cheatsheet

Change-Id: I457c5e42e3758789f29541d38d6f6c2e25532897
Signed-off-by: Michael Ochmann <michael.ochmann@sap.com>
2016-07-06 10:54:42 +02:00

30 lines
637 B
Plaintext

= kill
== NAME
kill - Cancel or abort a background task
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _kill_ <ID> ...
--
== DESCRIPTION
Cancels a scheduled task from the queue. If the task has already
been started, requests for the task to cancel as soon as it reaches
its next cancellation point (which is usually blocking IO).
== ACCESS
Caller must be a member of the privileged 'Administrators' group,
or have been granted link:access-control.html#capability_kill[the 'Kill Task' global capability].
== SCRIPTING
Intended for interactive use only.
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------