Re: [PATCH 0/4] git-worktree documentation cleanups

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, Aug 3, 2020 at 1:57 PM Martin Ågren <martin.agren@xxxxxxxxx> 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.



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux