From: Derrick Stolee <derrickstolee@github.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Derrick Stolee via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, gitster@pobox.com, me@ttaylorr.com,
Johannes.Schindelin@gmx.de
Subject: Rendering back-ticks in plaintext docs (was Re: [PATCH] git-rebase.txt: use back-ticks consistently)
Date: Tue, 28 Jun 2022 09:20:24 -0400 [thread overview]
Message-ID: <a01c1ff7-74a7-b32f-1a1e-a8f2e840ae31@github.com> (raw)
In-Reply-To: <220628.86k091f5fy.gmgdl@evledraar.gmail.com>
On 6/28/2022 6:22 AM, Ævar Arnfjörð Bjarmason wrote:
>
> On Mon, Jun 27 2022, Derrick Stolee via GitGitGadget wrote:
>
>> From: Derrick Stolee <derrickstolee@github.com>
>
> This looks 99% good, but...
>> 3. Focus on the edits that most-recently edited these lines. Doing some
>> scripting, I was able to construct this date-sorted list of previous
>> edits (by diffing the git blame output before and after this
>> change). The most-recent changes before this are:
>
> I think this is fine, but I want to recommend doc-diff in your toolkit,
> e.g.:
Thanks for the recommendation!
> $ Documentation/doc-diff HEAD~ HEAD -- -U0|cat
> diff --git a/e4a4b31577c7419497ac30cebe30d755b97752c5/home/avar/share/man/man1/git-rebase.1 b/e37244faa0a730bb930dac4e10d8eed4af682a5d/home/avar/share/man/man1/git-rebase.1
> index 91ccda823b2..41dfbee38a4 100644
> --- a/e4a4b31577c7419497ac30cebe30d755b97752c5/home/avar/share/man/man1/git-rebase.1
> +++ b/e37244faa0a730bb930dac4e10d8eed4af682a5d/home/avar/share/man/man1/git-rebase.1
> @@ -489,2 +489,2 @@ OPTIONS
> - Append "exec <cmd>" after each line creating a commit in the final
> - history. <cmd> will be interpreted as one or more shell commands.
> + Append exec <cmd> after each line creating a commit in the final
> + history. <cmd> will be interpreted as one or more shell commands.
> @@ -502 +502 @@ OPTIONS
> - If --autosquash is used, "exec" lines will not be appended for the
> + If --autosquash is used, exec lines will not be appended for the
> @@ -880 +880 @@ NOTES
> - When the git-rebase command is run, it will first execute a
> + When the git rebase command is run, it will first execute a
>
> I see Phillip spotted some of this already, but the "exec" change here
> looks unwanted, i.e. let's use double quotes there.
This is definitely an issue where I was looking at the HTML formatted
output, which respects back-ticks. Thanks for pointing out that the
text docs just ignore back-ticks. This seems problematic, in my opinion.
Is it possible to update our doc formatting to convert back-ticks into
something like single quotes? That would help these plain-text documents
point out these places where exact strings are very important.
I also have no idea where to look to make such a change, and it would be
very wide-ranging. I just think that the plaintext docs are currently a
lossy medium and we should work to improve that.
Thanks,
-Stolee
next prev parent reply other threads:[~2022-06-28 13:26 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-27 21:21 [PATCH] git-rebase.txt: use back-ticks consistently Derrick Stolee via GitGitGadget
2022-06-28 9:59 ` Phillip Wood
2022-06-28 19:29 ` Derrick Stolee
2022-06-28 10:22 ` Ævar Arnfjörð Bjarmason
2022-06-28 13:20 ` Derrick Stolee [this message]
2022-06-28 16:59 ` Rendering back-ticks in plaintext docs (was Re: [PATCH] git-rebase.txt: use back-ticks consistently) Junio C Hamano
2022-06-28 16:54 ` [PATCH] git-rebase.txt: use back-ticks consistently Junio C Hamano
2022-06-28 19:40 ` Derrick Stolee
2022-06-28 20:02 ` [PATCH v2] " Derrick Stolee via GitGitGadget
2022-06-28 21:49 ` Junio C Hamano
2022-06-29 9:31 ` Phillip Wood
2022-06-29 12:40 ` Derrick Stolee
2022-06-30 17:18 ` Junio C Hamano
2022-06-29 12:43 ` Derrick Stolee
2022-06-29 9:27 ` Phillip Wood
2022-06-29 12:41 ` Derrick Stolee
2022-06-29 13:21 ` [PATCH v3] " Derrick Stolee via GitGitGadget
2022-06-29 15:21 ` Phillip Wood
2022-06-30 17:25 ` Junio C Hamano
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=a01c1ff7-74a7-b32f-1a1e-a8f2e840ae31@github.com \
--to=derrickstolee@github.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.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).