Re: [PATCH 2/2] doc: documentation update for the branch track changes

From: Jay Soffian <jaysoffian@gmail.com>
Date: Feb 19, 2008, 22:09 UTC
Message-ID: <76718490802191409w4ca693dcr6a0c1006645ad907@mail.gmail.com>
In-Reply-To: <7vfxvoiqb5.fsf@gitster.siamese.dyndns.org>

On Feb 19, 2008 4:34 PM, Junio C Hamano <gitster@pobox.com> wrote:

> Micronit; I think this ", or" should be ", and".

Probably, I just kept the existing wording. Should you go over all the current docs with the same fine-toothed comb you're applying here, you'd end up in a hole from which you might never emerge. :-)

> Micronit; we would want to create track-options.txt and then
> include::track-options.txt[] from here and in git-branch.txt
> (that can be done later).

Yes, lots of opportunity for refactoring the documentation. Was trying to keep the change small.

Show 7 quoted lines

> Otherwise, the patch looks fine, and I'll queue this as-is,
> together with your [1/2] (with the "oops, commit message is
> stale" amended in).  We can incrementally improve on these
> in-tree from here on.
>
> I am very tempted to squish the "s/,or /, and/" change in while
> applying [2/2], though.

Thanks, either way.

Show 5 quoted lines

> By the way, please do not get discouraged to send-in the doc
> clean-ups.  I "gave up (for now)" last night because it was
> getting late, I had other patches to review and accept/respond,
> and I felt I did not have time to comment on a patch that mixes
> clean-ups and feature enhancements at that point.

Fair enough, it was the "now this is getting tiresome" that raised my hackles. but no worries, I think I may be getting the hang of this...

Show 5 quoted lines

> It is a good idea to organize a series so that clean-ups to
> existing stuff that you are going to touch come first, and then
> your own enhancements come on top, for a few reasons:
>
>  [...]

Understood and appreciated. I think I didn't realize the cleanup was needed till after I sent in the patches and realized, hey, I guess I need to add some documentation too... I know better for next time.

Thanks again for all your help on this.

j.