From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16967 invoked by alias); 4 Dec 2006 19:45:42 -0000 Received: (qmail 16958 invoked by uid 22791); 4 Dec 2006 19:45:41 -0000 X-Spam-Check-By: sourceware.org Received: from nitzan.inter.net.il (HELO nitzan.inter.net.il) (192.114.186.20) by sourceware.org (qpsmtpd/0.31) with ESMTP; Mon, 04 Dec 2006 19:45:34 +0000 Received: from HOME-C4E4A596F7 (IGLD-84-229-248-161.inter.net.il [84.229.248.161]) by nitzan.inter.net.il (MOS 3.7.3a-GA) with ESMTP id FJN02206 (AUTH halo1); Mon, 4 Dec 2006 21:45:29 +0200 (IST) Date: Mon, 04 Dec 2006 19:45:00 -0000 Message-Id: From: Eli Zaretskii To: Nick Roberts CC: gdb-patches@sources.redhat.com In-reply-to: <17779.42719.879365.463927@kahikatea.snap.net.nz> (message from Nick Roberts on Mon, 4 Dec 2006 17:41:03 +1300) Subject: Re: [commit] Doc: -var-delete Reply-to: Eli Zaretskii References: <17779.39827.835325.436366@kahikatea.snap.net.nz> <17779.42719.879365.463927@kahikatea.snap.net.nz> X-IsSubscribed: yes Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2006-12/txt/msg00025.txt.bz2 > From: Nick Roberts > Date: Mon, 4 Dec 2006 17:41:03 +1300 > Cc: gdb-patches@sources.redhat.com > > I was trying to apply the definition in MAINTAINERS: > > An "obvious fix" means that there is no possibility that anyone will > disagree with the change. > > As I'm documenting existing (undocumented) functionality I can't see how anyone > can disagree. The _need_ for documenting an existing feature is indisputable (at least in this case, since that is my policy; you know as well as I do that, in the case of Emacs, for example, RMS has a different policy, so even the need for documenting an existing feature does not necessarily constitute a good-enough reason). However, _how_ it should be documented is not obvious in any way; I could express the same idea as you did in about a dozen different ways. > Why do you think it is not obvious? Because about the only kind of fix in the docs that is really obvious is a typo or bad English.