From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Bastien Newsgroups: gmane.emacs.devel Subject: Improve the docstring of case-fold-search Date: Wed, 22 Jul 2009 04:17:10 +0200 Message-ID: <877hy1ea1l.fsf@bzg.ath.cx> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: ger.gmane.org 1248229066 12361 80.91.229.12 (22 Jul 2009 02:17:46 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 22 Jul 2009 02:17:46 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Jul 22 04:17:39 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 1MTROj-0001rX-6X for ged-emacs-devel@m.gmane.org; Wed, 22 Jul 2009 04:17:37 +0200 Original-Received: from localhost ([127.0.0.1]:38374 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MTROi-0002EH-7b for ged-emacs-devel@m.gmane.org; Tue, 21 Jul 2009 22:17:36 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MTROd-0002EA-3T for emacs-devel@gnu.org; Tue, 21 Jul 2009 22:17:31 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MTROX-0002DK-Fv for emacs-devel@gnu.org; Tue, 21 Jul 2009 22:17:29 -0400 Original-Received: from [199.232.76.173] (port=57577 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MTROX-0002DC-BU for emacs-devel@gnu.org; Tue, 21 Jul 2009 22:17:25 -0400 Original-Received: from mail-px0-f193.google.com ([209.85.216.193]:63379) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1MTROX-0005Qc-2Q for emacs-devel@gnu.org; Tue, 21 Jul 2009 22:17:25 -0400 Original-Received: by pxi31 with SMTP id 31so2390992pxi.14 for ; Tue, 21 Jul 2009 19:17:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlemail.com; s=gamma; h=domainkey-signature:received:received:from:to:subject:user-agent :date:message-id:mime-version:content-type; bh=ZRojVkTCV6zEsYKRfcY+rQ823SemhBHHX5MzEWQj5UE=; b=nTS67sfyClGGQSpr1b1XcYo+gLIz5v9T/qvvr8oPGSfC/7G2JeKeFAACunU+QSj7u0 ZAJdX8USuADzlguqmZ0V/Xfht1zpyxhYYj/nQNtFFDkl7gzn7tb1EprtBBm+pEdv2gQr IJcLlJyFxTxLqqrrBjUjncv0idjmdlnZCMoo4= DomainKey-Signature: a=rsa-sha1; c=nofws; d=googlemail.com; s=gamma; h=from:to:subject:user-agent:date:message-id:mime-version :content-type; b=G9xKCxcW3BVesBY4vzR407WniGM8nHvA6dnSIAvwH792uIliGRNIVpnvLzPXm/SCGw DJFwGoZHKLe8NfLsBa40UrPt2yWIOyVuO7nGQTnTQWDvyCtZNOWVQ29pAY/6RZH1dO2w NqmTFgliCYNEyr+p0jyHFQPKLgl/pje20fORM= Original-Received: by 10.114.195.7 with SMTP id s7mr622013waf.24.1248229043379; Tue, 21 Jul 2009 19:17:23 -0700 (PDT) Original-Received: from bzg.ath.cx ([222.29.50.13]) by mx.google.com with ESMTPS id f21sm2499497rvb.2.2009.07.21.19.17.19 (version=TLSv1/SSLv3 cipher=RC4-MD5); Tue, 21 Jul 2009 19:17:21 -0700 (PDT) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.1.50 (gnu/linux) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 2) 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:112975 Archived-At: --=-=-= I suggest to complete the docstring of `case-fold-search' like the attached patch does. In the current docstring, the expression "ignore case" is not really appropriate because the search will not ignore uppercase characters in the search string. A very short way to tell this would be "*Non-nil if searches and matches should ignore lowercase." But while accurate, this is confusing IMO. Hence the long sentence in this patch, inspired by the "Search case" section of Emacs manual. Should I apply it? --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=buffer.c.patch --- buffer.c.~1.583.~ 2009-07-17 21:12:21.000000000 +0200 +++ buffer.c 2009-07-22 03:55:26.000000000 +0200 @@ -5727,7 +5727,9 @@ DEFVAR_PER_BUFFER ("case-fold-search", ¤t_buffer->case_fold_search, Qnil, - doc: /* *Non-nil if searches and matches should ignore case. */); + doc: /* *Non-nil if searches and matches should ignore case. +If there is an uppercase character in the search string +then the search becomes case sensitive. */); DEFVAR_PER_BUFFER ("fill-column", ¤t_buffer->fill_column, make_number (Lisp_Int), --=-=-= -- Bastien --=-=-=--