opendev/gerrit
Code Issues Proposed changes

Fix broken synopsis formatting in documentation

Browse Source 
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>
This commit is contained in:
Michael Ochmann
2016-06-23 17:07:37 +02:00
parent 9ea8b684b7
commit e2d76a1c23
44 changed files with 109 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/cmd-plugin-install.txt
View File

@@ -6,8 +6,9 @@ plugin install - Install/Add a plugin.
plugin add - Install/Add a plugin.
== SYNOPSIS
[verse]
--
'ssh' -p <port> <host> 'gerrit plugin install | add'
_ssh_ -p <port> <host> _gerrit plugin install_ | _add_
[--name <NAME> | -n <NAME>]
- | <URL> | <PATH>
--