From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Git mirrors Date: Mon, 17 Oct 2011 05:04:31 -0400 Message-ID: References: <871uuksdxi.fsf@lifelogs.com> <87lissh32y.fsf@wanadoo.es> <87zkh8e286.fsf@catnip.gol.com> <87d3e4gttq.fsf@wanadoo.es> <87ehyjrhxh.fsf@uwakimon.sk.tsukuba.ac.jp> <87d3e2rfte.fsf@uwakimon.sk.tsukuba.ac.jp> <878voqfiaw.fsf@wanadoo.es> <87zkh4bhho.fsf@wanadoo.es> <87zkh4nrcr.fsf@uwakimon.sk.tsukuba.ac.jp> <87zkh0ozjz.fsf@uwakimon.sk.tsukuba.ac.jp> Reply-To: Eli Zaretskii NNTP-Posting-Host: lo.gmane.org X-Trace: dough.gmane.org 1318842300 5526 80.91.229.12 (17 Oct 2011 09:05:00 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 17 Oct 2011 09:05:00 +0000 (UTC) Cc: ofv@wanadoo.es, lekktu@gmail.com, stephen@xemacs.org, rms@gnu.org, emacs-devel@gnu.org To: Andreas Schwab Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Oct 17 11:04:55 2011 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1RFj7v-000744-Ax for ged-emacs-devel@m.gmane.org; Mon, 17 Oct 2011 11:04:55 +0200 Original-Received: from localhost ([::1]:35120 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RFj7u-000718-Sa for ged-emacs-devel@m.gmane.org; Mon, 17 Oct 2011 05:04:54 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:38679) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RFj7o-00070Q-GJ for emacs-devel@gnu.org; Mon, 17 Oct 2011 05:04:52 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RFj7h-0008Hy-Ic for emacs-devel@gnu.org; Mon, 17 Oct 2011 05:04:48 -0400 Original-Received: from fencepost.gnu.org ([140.186.70.10]:36192) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RFj7h-0008Hm-H2 for emacs-devel@gnu.org; Mon, 17 Oct 2011 05:04:41 -0400 Original-Received: from eliz by fencepost.gnu.org with local (Exim 4.71) (envelope-from ) id 1RFj7X-0006Iz-Sg; Mon, 17 Oct 2011 05:04:31 -0400 In-reply-to: (message from Andreas Schwab on Mon, 17 Oct 2011 10:31:33 +0200) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.10 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:145247 Archived-At: > From: Andreas Schwab > Cc: "Stephen J. Turnbull" , ofv@wanadoo.es, lekktu@gmail.com, rms@gnu.org, emacs-devel@gnu.org > Date: Mon, 17 Oct 2011 10:31:33 +0200 > > Manpages are not tutorials, they are reference documentation. If you > need a tutorial there are a lot of good ones available. Tutorial is not the issue here. (Git does come with an official tutorial man page.) The issue here is that every command should be explained in a way that is suitable both for the first reading by someone inexperienced, and as reference material for someone experienced who knows exactly what she is after. I didn't find any git documentation that fills the former niche (but I admit that I didn't look too hard). Look at the Emacs documentation, for example. Would it be sufficient to have just the TUTORIAL and then an alphabetical listing of all the commands and options, each one with its doc string? I don't think so.