Re: [PATCH v2 2/2] commit-graph.txt: improve formatting for asciidoc
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Aug 21, 2018, 19:35 UTC
- Message-ID
- <CAPig+cR7OuF8LfZFY-b6egCOn0-p1uC5KeerhOig5FAC4rqrrw@mail.gmail.com>
- In-Reply-To
- <6cf253c2a6a091520e1376839dff8b97869c9808.1534879749.git.gitgitgadget@gmail.com>
On Tue, Aug 21, 2018 at 3:29 PM Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com> wrote:
Show 8 quoted lines
> When viewing commit-graph.txt as a plain-text document, it makes > sense to keep paragraphs left-padded between bullet points. > However, asciidoc converts these left-padded paragraphs as monospace > fonts, creating an unpleasant document. Remove the padding. > > The "Future Work" section includes a bulleted list of items, and one > item has sub-items. These do not render properly in asciidoc, so > remove the sub-list and incorporate them into the paragraph.
See: http://asciidoc.org/userguide.html#_bulleted_lists
And...
Show 16 quoted lines
> diff --git a/Documentation/technical/commit-graph.txt b/Documentation/technical/commit-graph.txt > @@ -148,13 +145,13 @@ Related Links > - "I think we should be moving more in the direction of keeping > - repo-local caches for optimizations. Reachability bitmaps have been > - a big performance win. I think we should be doing the same with our > - properties of commits. Not just generation numbers, but making it > - cheap to access the graph structure without zlib-inflating whole > - commit objects (i.e., packv4 or something like the "metapacks" I > - proposed a few years ago)." > +"I think we should be moving more in the direction of keeping > + repo-local caches for optimizations. Reachability bitmaps have been > + a big performance win. I think we should be doing the same with our > + properties of commits. Not just generation numbers, but making it > + cheap to access the graph structure without zlib-inflating whole > + commit objects (i.e., packv4 or something like the "metapacks" I > + proposed a few years ago)."
Perhaps this should be using a quote block: http://asciidoc.org/userguide.html#_quote_blocks