]> git.feebdaed.xyz Git - 0xmirror/git.git/commit
doc: commit-graph.adoc: fix up some formatting
authorRamsay Jones <ramsay@ramsayjones.plus.com>
Thu, 16 Oct 2025 20:03:00 +0000 (21:03 +0100)
committerJunio C Hamano <gitster@pobox.com>
Thu, 16 Oct 2025 20:55:52 +0000 (13:55 -0700)
commitb770ed9545edf4919ea39d6fdd54fca402d28930
treecf33ea6a7b8ae6d72f0600002ba3e3ff30f55eee
parent45e8b7c2d44043f4328c9aa4da31671df2546a79
doc: commit-graph.adoc: fix up some formatting

The formatting markup syntax used in this document (markdown?) is not
interpreted correctly by asciidoc or asciidoctor. The main problem is
the use of a '## ' prefix markup for some sub-headings, along with the
use of '```' code markup and some missing literal blocks.

In order to improve the (html) document formatting:

  - replace the '## ' prefix sub-title syntax with the '~~' underlining
    syntax for the relevant sub-headings.
  - replace the '```' code markup, which causes asciidoc(tor) to simply
    remove the marked up text, with a literal block '----' markup.
  - the second ascii diagram, in the 'Merging commit-graph files'
    section, is not rendered correctly by asciidoctor (asciidoc is fine)
    so enclose it in a '....' block.

Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/commit-graph.adoc