All of lore.kernel.org
 help / color / mirror / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: Git List <git@vger.kernel.org>, Duy Nguyen <pclouds@gmail.com>
Subject: Re: [PATCH 0/4] git-worktree documentation cleanups
Date: Mon, 3 Aug 2020 19:54:24 -0400	[thread overview]
Message-ID: <CAPig+cQtcxqQDAQ5bO6ica+Z7dd2+r8B+kXm0RK7qhpsAiX_xg@mail.gmail.com> (raw)
In-Reply-To: <20200803175717.7465-1-martin.agren@gmail.com>

On Mon, Aug 3, 2020 at 1:57 PM Martin Ågren <martin.agren@gmail.com> wrote:
> I offer the following suggestions on top. If you agree with them, or
> some of them, you might want to squash them into the various patches.

Thanks for the review and suggestions for additional changes. See a
few minor comments below...

> -"linked working tree" as opposed to the "main working tree" prepared by "git
> -init" or "git clone".  A repository has one main working tree (if it's not a
> +"linked working tree" as opposed to the "main working tree" prepared by linkgit:git-init[1]
> +or linkgit:git-clone[1].  A repository has one main working tree (if it's not a

Good idea, though this could just go atop this series.

> -directory specific files such as HEAD, index, etc. As a convenience,
> +directory specific files such as `HEAD`, `index`, etc. As a convenience,

I intentionally left HEAD as-is because it consistently lacks quotes
in this document, and I didn't feel strongly about it being quoted or
not. Such a change could easily go atop this series.

I did see and consider adding backticks around "index" here but
likewise didn't feel strongly about it at the time. But upon
reconsideration, as a literal filename, you're right that it ought to
be typeset specially.

> @@ -166,7 +166,7 @@ This can also be set up as the default behaviour by using the
> -       "--track" in linkgit:git-branch[1] for details.
> +       `--track` in linkgit:git-branch[1] for details.

I missed this one.

> -       With 'add', suppress feedback messages.
> +       With `add`, suppress feedback messages.

And this.

> -       With `prune`, only expire unused working trees older than <time>.
> +       With `prune`, only expire unused working trees older than `<time>`.

Ditto.

> -on "worktreeConfig" extension, e.g.:
> +on the "worktreeConfig" extension, e.g.:

In addition to the grammo you spotted, the quotes around
worktreeConfig should be backticks.

I'll think go ahead and re-roll, adding a couple new patches,
respectively, for the linkgit:'s you pointed out and typesetting
`HEAD` specially.

  reply	other threads:[~2020-08-03 23:54 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-03  5:36 [PATCH 0/4] git-worktree documentation cleanups Eric Sunshine
2020-08-03  5:36 ` [PATCH 1/4] git-worktree.txt: employ fixed-width typeface consistently Eric Sunshine
2020-08-03  5:36 ` [PATCH 2/4] git-worktree.txt: consistently use term "working tree" Eric Sunshine
2020-08-03  5:36 ` [PATCH 3/4] git-worktree.txt: fix minor grammatical issues Eric Sunshine
2020-08-03  5:36 ` [PATCH 4/4] git-worktree.txt: make start of new sentence more obvious Eric Sunshine
2020-08-03 16:11 ` [PATCH 0/4] git-worktree documentation cleanups Taylor Blau
2020-08-03 17:14   ` Junio C Hamano
2020-08-03 17:57 ` Martin Ågren
2020-08-03 23:54   ` Eric Sunshine [this message]
2020-08-04  0:15     ` Junio C Hamano
2020-08-04  0:55 ` [PATCH v2 0/5] " Eric Sunshine
2020-08-04  0:55   ` [PATCH v2 1/5] git-worktree.txt: employ fixed-width typeface consistently Eric Sunshine
2020-08-04  0:55   ` [PATCH v2 2/5] git-worktree.txt: consistently use term "working tree" Eric Sunshine
2020-08-04  0:55   ` [PATCH v2 3/5] git-worktree.txt: fix minor grammatical issues Eric Sunshine
2020-08-04  0:55   ` [PATCH v2 4/5] git-worktree.txt: make start of new sentence more obvious Eric Sunshine
2020-08-04  0:55   ` [PATCH v2 5/5] git-wortkree.txt: link to man pages when citing other Git commands Eric Sunshine
2020-08-04  1:10   ` [PATCH v2 0/5] git-worktree documentation cleanups Taylor Blau
2020-08-04  4:28   ` Martin Ågren
2020-08-04  4:44     ` Eric Sunshine
2020-08-04  5:23       ` Martin Ågren

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=CAPig+cQtcxqQDAQ5bO6ica+Z7dd2+r8B+kXm0RK7qhpsAiX_xg@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=git@vger.kernel.org \
    --cc=martin.agren@gmail.com \
    --cc=pclouds@gmail.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. 
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.