Re: Remote branches and better documentation

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

 



El 10/9/2007, a las 23:50, Joel Becker escribió:

On Mon, Sep 10, 2007 at 02:18:27PM -0700, Steven Grimm wrote:
Joel Becker wrote:
	The suggestions are pretty simple.  First, when behavior is
changed invisibly (as the remote branch stuff was), can we note it in
the documentation?  I don't mean the ChangeLog, I mean the manpage.

Please, no. I understand where you're coming from with this request, but think of it from the point of view of non-long-time users (or users who have been keeping up with the changelog) who want to look up some piece of information. The last thing they want to have to do is read through a bunch of irrelevant information related to the behavior of obsolete versions of
git they've never even used.

	I do git clone.  It doesn't do what it has always done.  I think
it has failed. I check git-clone(7). I see nothing relevant. That's a
problem.  You can't just claim "only people new to the system matter"
any more than "only people who follow git@xxxxxxxxxxxxxxx matter".  In
fact, when you are silently changing existing behavior, it's the people
in between that will get bitten.

But that's precisely the group release notes are for; existing users who need to be informed of any changes to the way things work.

The man page should be a concise reference of the *current* behaviour of the tool with only minimal references to historical changes.

Cheers,
Wincent

-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[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