GNU bug report logs - #23902
25.1.50; Strange warning on string-collate-equalp's docstring

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: oscarfv <at> telefonica.net (Óscar Fuentes)
Subject: bug#23902: closed (Re: bug#23902: 25.1.50; Strange warning on
 string-collate-equalp's docstring)
Date: Fri, 08 Jul 2016 10:12:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#23902: 25.1.50; Strange warning on string-collate-equalp's docstring

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 23902 <at> debbugs.gnu.org.

-- 
23902: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=23902
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: oscarfv <at> telefonica.net, 23902-done <at> debbugs.gnu.org
Subject: Re: bug#23902: 25.1.50;
 Strange warning on string-collate-equalp's docstring
Date: Fri, 08 Jul 2016 13:11:20 +0300

> From: Michael Heerdegen <michael_heerdegen <at> web.de>
> Cc: oscarfv <at> telefonica.net,  23902 <at> debbugs.gnu.org
> Date: Thu, 07 Jul 2016 23:52:30 +0200
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > Yes, documentation changes are okay on emacs-25.
> 
> Oh, I see now this function is defined in C.  I'm not sure what I
> exactly have to do (the docstring is in a comment?).

Yes, doc strings in C are comments.  They are collected by
make-docfile and written to etc/DOC at build time.

> Maybe you can make the change this time, Eli?

I did, but you shouldn't be scared like that of making such trivial
changes in the C sources.  There are lots of examples in the *.c files
that you could use to see the simple formatting we use.  The results
are easy to check: just build Emacs and type "C-h f".  And of course,
you can ask questions if you feel uncertain of something.

Thanks.

[Message part 3 (message/rfc822, inline)]

From: oscarfv <at> telefonica.net (Óscar Fuentes)
To: bug-gnu-emacs <at> gnu.org
Subject: 25.1.50; Strange warning on string-collate-equalp's docstring
Date: Wed, 06 Jul 2016 00:05:57 +0200

The mentioned docstring ends with


     Do _not_ use this function to compare file names for equality, only
     for sorting them.


which makes no sense to me. First of all, what's so special about file
names to mention them here? And then, how one is supposed to use an
equality predicate for sorting? (We have string-collate-lessp for that)



In GNU Emacs 25.1.50.1 (x86_64-pc-linux-gnu, X toolkit)
 of 2016-06-29 built on qcore
Repository revision: 652b638b0f80fda2abc316f3d1b0f005c7d28e1a
Windowing system distributor 'The X.Org Foundation', version 11.0.11803000
System Description:	Ubuntu 16.04 LTS

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.