unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 3888@emacsbugs.donarmstrong.com, cyd@stupidchicken.com
Subject: bug#3888: Some variables get the wrong, platform-specific, documentation
Date: Wed, 22 Jul 2009 21:45:51 +0300	[thread overview]
Message-ID: <83r5w84kv4.fsf@gnu.org> (raw)
In-Reply-To: <jwvprbsr2pt.fsf-monnier+emacsbugreports@gnu.org>

> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: cyd@stupidchicken.com,  3888@emacsbugs.donarmstrong.com
> Date: Wed, 22 Jul 2009 14:32:49 -0400
> 
> A defvar can trivially be moved from Lisp to C.  I don't see any
> obstacle here.  As for functions, it's even easier since you can rename
> one of the two from `foo' to `foo-internal' or somesuch and move some
> code from one to the other.  We've already done such things for lote and
> lots of functions.  There's no technical problem here.

No technical problems, but experience teaches me that these solutions
don't hold in practice, i.e. new non-internal functions that overload
others pop up with time.

Also, the `foo-internal' trick does not solve the problem of the doc
string that needs to say something platform-specific without bothering
too much the users of other platforms.

Finally, there's (an admittedly very specific and quite rare) problem
of ls-lisp and its ilk that overload the default implementation with
something utterly different, and whose doc string _must_ be very
different if we want it to be useful.

I tried to think of an infrastructure that would solve all these
use-cases in a relatively elegant way that would not become a
maintenance burden.





  reply	other threads:[~2009-07-22 18:45 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-07-20 20:25 bug#3888: Some variables get the wrong, platform-specific, documentation Chong Yidong
2009-07-21  3:12 ` Eli Zaretskii
2009-07-21 16:18 ` Stefan Monnier
2009-07-21 18:30   ` Eli Zaretskii
2009-07-22 18:32     ` Stefan Monnier
2009-07-22 18:45       ` Eli Zaretskii [this message]
2009-07-23  2:43         ` Stefan Monnier
  -- strict thread matches above, loose matches on Subject: below --
2009-07-20 21:33 bug#3888: " Chong Yidong
2009-07-21 18:59 ` Eli Zaretskii
     [not found] <83k51y3up4.fsf@gnu.org>
2009-07-20 18:21 ` Glenn Morris
2009-07-20 18:56   ` Eli Zaretskii
2009-07-24 16:40   ` bug#3888: marked as done (Some variables get the wrong, platform-specific, documentation) Emacs bug Tracking System
2009-07-24 17:41     ` bug#3888: Some variables get the wrong, platform-specific, documentation Glenn Morris

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83r5w84kv4.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=3888@emacsbugs.donarmstrong.com \
    --cc=cyd@stupidchicken.com \
    --cc=monnier@iro.umontreal.ca \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).