[PATCH 1/3] Documentation/git-diff-tree.txt: fix formatting

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Some more recent versions of Asciidoctor issue the following warning
while building the documentation:

      ASCIIDOC git-diff-tree.xml
  asciidoctor: WARNING: diff-format.txt: line 2: unterminated listing block

This highlights an issue where the "Raw output format" header is not
rendered as a header, and the rest of the document is rendered in
monospace.  This is not caused by 'diff-format.txt' in itself, but
rather by 'git-diff-tree.txt' including 'pretty-formats.txt' and
'diff-format.txt' on subsequent lines, while the former happens to end
with monospace-formatted example commands.

Fix this by inserting an empty line between the two include::
directives.

The page rendered with AsciiDoc doesn't have this formatting issue.

Signed-off-by: SZEDER Gábor <szeder.dev@xxxxxxxxx>
---
 Documentation/git-diff-tree.txt | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 24f32e8c54..5c8a2a5e97 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -118,6 +118,7 @@ include::pretty-options.txt[]
 
 
 include::pretty-formats.txt[]
+
 include::diff-format.txt[]
 
 GIT
-- 
2.21.0.539.g07239c3a71.dirty




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux