All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Johannes Sixt <j6t@kdbg.org>
Cc: "Jean-Noël Avila" <jn.avila@free.fr>,
	"Patrick Steinhardt" <ps@pks.im>,
	git@vger.kernel.org,
	"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
Subject: Re: [PATCH v2 3/5] doc: git-diff: apply format changes to diff-format
Date: Wed, 13 Nov 2024 08:03:37 +0900	[thread overview]
Message-ID: <xmqq8qto3vhy.fsf@gitster.g> (raw)
In-Reply-To: <6c1c1ae2-f38a-4458-a9ad-2fad3e56fc32@kdbg.org> (Johannes Sixt's message of "Tue, 12 Nov 2024 19:51:37 +0100")

Johannes Sixt <j6t@kdbg.org> writes:

> Am 11.11.24 um 17:53 schrieb Jean-Noël Avila via GitGitGadget:
>> -The raw output format from "git-diff-index", "git-diff-tree",
>> -"git-diff-files" and "git diff --raw" are very similar.
>> +The raw output format from `git-diff-index`, `git-diff-tree`,
>> +`git-diff-files` and `git diff --raw` are very similar.
>
> Throughout this document we see a lot of commands with dashes `git-foo`.
> Does this have any significance, or should they be corrected to the
> dashless form `git foo`? It could even be a "while at it"-change as you
> are touching every instance anyway.

Yup, these "git-foo" are historical wart from pre Git 1.6 days.

>>  These commands all compare two sets of things; what is
>>  compared differs:
>>  
>> -git-diff-index <tree-ish>::
>> -        compares the <tree-ish> and the files on the filesystem.
>> +`git-diff-index <tree-ish>`::
>> +	compares the _<tree-ish>_ and the files on the filesystem.
>
> Now that the backtick formats the content as in the synopsis, why is it
> written _<tree-ish>_ and not `<tree-ish>` in the running text?

Perhaps that is because the body text does want to show the
placeholder in _italics_ but not as a `literal` string?

  reply	other threads:[~2024-11-12 23:03 UTC|newest]

Thread overview: 65+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-04 20:05 [PATCH 0/5] doc: git diff reformatting Jean-Noël Avila via GitGitGadget
2024-08-04 20:05 ` [PATCH 1/5] doc: git-diff: apply new documentation guidelines Jean-Noël Avila via GitGitGadget
2024-08-05  9:11   ` Patrick Steinhardt
2024-08-05 18:51     ` Jean-Noël AVILA
2024-08-06  6:27       ` Patrick Steinhardt
2024-08-04 20:05 ` [PATCH 2/5] doc: git-diff: apply format changes to diff-options Jean-Noël Avila via GitGitGadget
2024-08-04 20:05 ` [PATCH 3/5] doc: git-diff: apply format changes to diff-format Jean-Noël Avila via GitGitGadget
2024-08-04 20:05 ` [PATCH 4/5] doc: git-diff: apply format changes to diff-generate-patch Jean-Noël Avila via GitGitGadget
2024-08-05  5:53   ` Johannes Sixt
2024-08-05 16:08     ` Junio C Hamano
2024-08-07 20:43       ` [RFC] formatting macro Jean-Noël AVILA
2024-08-12  6:35         ` Johannes Sixt
2024-08-12 15:22           ` Junio C Hamano
2024-08-13 20:42           ` Jean-Noël AVILA
2024-08-05 20:12     ` [PATCH 4/5] doc: git-diff: apply format changes to diff-generate-patch Jean-Noël AVILA
2024-08-04 20:05 ` [PATCH 5/5] doc: git-diff: apply format changes to config part Jean-Noël Avila via GitGitGadget
2024-11-11 16:53 ` [PATCH v2 0/5] doc: git diff reformatting Jean-Noël Avila via GitGitGadget
2024-11-11 16:53   ` [PATCH v2 1/5] doc: git-diff: apply new documentation guidelines Jean-Noël Avila via GitGitGadget
2024-11-12  0:48     ` Junio C Hamano
2024-11-12  8:40       ` Jean-Noël Avila
2024-11-12  9:13         ` Junio C Hamano
2024-11-12 18:28           ` Johannes Sixt
2024-11-12 23:01             ` Junio C Hamano
2024-11-13  7:31               ` Johannes Sixt
2024-11-13  8:59               ` Jean-Noël Avila
2024-11-11 16:53   ` [PATCH v2 2/5] doc: git-diff: apply format changes to diff-options Jean-Noël Avila via GitGitGadget
2024-11-12  0:52     ` Junio C Hamano
2024-11-12  9:04       ` Jean-Noël Avila
2024-11-12  9:14         ` Junio C Hamano
2024-11-11 16:53   ` [PATCH v2 3/5] doc: git-diff: apply format changes to diff-format Jean-Noël Avila via GitGitGadget
2024-11-12 18:51     ` Johannes Sixt
2024-11-12 23:03       ` Junio C Hamano [this message]
2024-11-13  7:39         ` Johannes Sixt
2024-11-13  8:10       ` Jean-Noël Avila
2024-11-11 16:53   ` [PATCH v2 4/5] doc: git-diff: apply format changes to diff-generate-patch Jean-Noël Avila via GitGitGadget
2024-11-11 16:53   ` [PATCH v2 5/5] doc: git-diff: apply format changes to config part Jean-Noël Avila via GitGitGadget
2024-11-12 18:51     ` Johannes Sixt
2024-11-13  8:12       ` Jean-Noël Avila
2024-11-16 19:36   ` [PATCH v3 0/5] doc: git diff reformatting Jean-Noël Avila via GitGitGadget
2024-11-16 19:36     ` [PATCH v3 1/5] doc: git-diff: apply new documentation guidelines Jean-Noël Avila via GitGitGadget
2024-11-17 14:04       ` Johannes Sixt
2024-11-17 16:44         ` Jean-Noël AVILA
2024-11-18  0:35           ` Junio C Hamano
2024-11-18  0:27         ` Junio C Hamano
2024-11-16 19:36     ` [PATCH v3 2/5] doc: git-diff: apply format changes to diff-options Jean-Noël Avila via GitGitGadget
2024-11-16 19:36     ` [PATCH v3 3/5] doc: git-diff: apply format changes to diff-format Jean-Noël Avila via GitGitGadget
2024-11-16 19:36     ` [PATCH v3 4/5] doc: git-diff: apply format changes to diff-generate-patch Jean-Noël Avila via GitGitGadget
2024-11-16 19:36     ` [PATCH v3 5/5] doc: git-diff: apply format changes to config part Jean-Noël Avila via GitGitGadget
2024-11-18 22:05     ` [PATCH v4 0/5] doc: git diff reformatting Jean-Noël Avila via GitGitGadget
2024-11-18 22:05       ` [PATCH v4 1/5] doc: git-diff: apply new documentation guidelines Jean-Noël Avila via GitGitGadget
2025-03-31  9:37         ` SZEDER Gábor
2025-03-31 12:55           ` [PATCH] doc: fix asciidoctor synopsis processing of triple-dots Jean-Noël Avila
2025-03-31 17:45             ` SZEDER Gábor
2025-03-31 20:30               ` Jean-Noël AVILA
2025-04-01 11:08               ` Jean-Noël Avila
2025-04-01 21:48                 ` Junio C Hamano
2025-04-02  6:49                   ` Jean-Noël Avila
2025-04-07 15:11                     ` Junio C Hamano
2024-11-18 22:05       ` [PATCH v4 2/5] doc: git-diff: apply format changes to diff-options Jean-Noël Avila via GitGitGadget
2024-11-18 22:05       ` [PATCH v4 3/5] doc: git-diff: apply format changes to diff-format Jean-Noël Avila via GitGitGadget
2024-11-18 22:05       ` [PATCH v4 4/5] doc: git-diff: apply format changes to diff-generate-patch Jean-Noël Avila via GitGitGadget
2024-11-18 22:05       ` [PATCH v4 5/5] doc: git-diff: apply format changes to config part Jean-Noël Avila via GitGitGadget
2024-11-26  4:32       ` [PATCH v4 0/5] doc: git diff reformatting Junio C Hamano
2024-11-26  6:55         ` Johannes Sixt
2024-11-26  7:15           ` 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

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

  git send-email \
    --in-reply-to=xmqq8qto3vhy.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=j6t@kdbg.org \
    --cc=jn.avila@free.fr \
    --cc=ps@pks.im \
    /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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.