From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Miles Bader Newsgroups: gmane.emacs.devel Subject: vc docstrings Date: Fri, 13 Mar 2009 08:31:17 +0900 Message-ID: <87r612mi7u.fsf@catnip.gol.com> Reply-To: Miles Bader NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1236900710 22526 80.91.229.12 (12 Mar 2009 23:31:50 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 12 Mar 2009 23:31:50 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Mar 13 00:33:07 2009 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1LhuOV-0005gx-U3 for ged-emacs-devel@m.gmane.org; Fri, 13 Mar 2009 00:32:56 +0100 Original-Received: from localhost ([127.0.0.1]:52799 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1LhuN9-0000zH-Vo for ged-emacs-devel@m.gmane.org; Thu, 12 Mar 2009 19:31:32 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1LhuN4-0000zA-IX for emacs-devel@gnu.org; Thu, 12 Mar 2009 19:31:26 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1LhuN3-0000yy-8Q for emacs-devel@gnu.org; Thu, 12 Mar 2009 19:31:26 -0400 Original-Received: from [199.232.76.173] (port=42185 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1LhuN3-0000yv-0e for emacs-devel@gnu.org; Thu, 12 Mar 2009 19:31:25 -0400 Original-Received: from smtp11.dentaku.gol.com ([203.216.5.73]:50229) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1LhuN1-00040Q-0v; Thu, 12 Mar 2009 19:31:23 -0400 Original-Received: from 218.231.175.8.eo.eaccess.ne.jp ([218.231.175.8] helo=catnip.gol.com) by smtp11.dentaku.gol.com with esmtpa (Dentaku) id 1LhuMy-0004cW-NJ; Fri, 13 Mar 2009 08:31:20 +0900 Original-Received: by catnip.gol.com (Postfix, from userid 1000) id D5D26DFF3; Fri, 13 Mar 2009 08:31:17 +0900 (JST) System-Type: x86_64-unknown-linux-gnu Original-Lines: 31 X-Virus-Scanned: ClamAV GOL (outbound) X-Abuse-Complaints: abuse@gol.com X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:109596 Archived-At: I notice `vc-next-action' has a docstring of the form: SHORT_DESCRIPTION For locking systems: ... LONG DESCRIPTION FOR LOCKING VCS For merging systems: ... LONG DESCRIPTION FOR MERGING VCS Given that all commonly used source-control systems these days are the "merging" type, shouldn't the section on "merging systems" be first? Also, I think many users are probably only vaguely aware that there _is_ such a distinction (how many people these days have ever used RCS?), so perhaps it would be a good idea to give a list of common systems of each type directly in the comment. E.g., change the "merging systems" header to: For merging systems (CVS, Subversion, Git, Bzr, Hg, Arch): [Maybe similar comments apply to other vc-... commands too.] Thanks, -Miles -- "Most attacks seem to take place at night, during a rainstorm, uphill, where four map sheets join." -- Anon. British Officer in WW I