Re: [PATCH] Documentation: enhanced "git for CVS users" doc about shared repositories

From: J. Bruce Fields <bfields@fieldses.org>
Date: Nov 7, 2007, 17:32 UTC
Message-ID: <20071107173217.GB10525@fieldses.org>
In-Reply-To: <Pine.LNX.4.64.0711070053320.4362@racer.site>

On Wed, Nov 07, 2007 at 12:55:49AM +0000, Johannes Schindelin wrote:

> Remember, those who read "git for CVS users" are _unwilling_ to spend the 
> time reading git documentation (at least for the most part).  If they 
> encounter something which is not useful to them, they will not just ignore 
> it, they will stop reading.

That might overstate the case a little, but I definitely agree that we should get people to the information they need as quickly as possible, and that adding more beginning-unix-administration will interfere with that goal for the intended audience.

And it's not just here--there's probably lots of basic unix-commandline stuff that we could include with the user-manual (how find/xargs pipes work, etc...), and that would similarly help one possible audience at the expense of bogging it down for another audience.

I think the way to help people without those prerequisites is by clearer statements of prerequisites, and references to documentation elsewhere where appropriate.

--b.