git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: gitgitgadget@gmail.com
Cc: Git List <git@vger.kernel.org>,
	Junio C Hamano <gitster@pobox.com>,
	Derrick Stolee <dstolee@microsoft.com>
Subject: Re: [PATCH v2 2/2] commit-graph.txt: improve formatting for asciidoc
Date: Tue, 21 Aug 2018 15:35:40 -0400	[thread overview]
Message-ID: <CAPig+cR7OuF8LfZFY-b6egCOn0-p1uC5KeerhOig5FAC4rqrrw@mail.gmail.com> (raw)
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:
> 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...

> 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

  reply	other threads:[~2018-08-21 19:35 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-21 12:53 [PATCH 0/1] Docs: Add commit-graph tech docs to Makefile Derrick Stolee via GitGitGadget
2018-08-21 12:53 ` [PATCH 1/1] " Derrick Stolee via GitGitGadget
2018-08-21 18:13   ` Junio C Hamano
2018-08-21 19:29 ` [PATCH v2 0/2] " Derrick Stolee via GitGitGadget
2018-08-21 19:29   ` [PATCH v2 1/2] " Derrick Stolee via GitGitGadget
2018-08-21 19:29   ` [PATCH v2 2/2] commit-graph.txt: improve formatting for asciidoc Derrick Stolee via GitGitGadget
2018-08-21 19:35     ` Eric Sunshine [this message]
2018-08-21 21:29     ` Junio C Hamano
2018-08-22  1:19       ` Derrick Stolee

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAPig+cR7OuF8LfZFY-b6egCOn0-p1uC5KeerhOig5FAC4rqrrw@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=dstolee@microsoft.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).