all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Chong Yidong <cyd@stupidchicken.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 3888@emacsbugs.donarmstrong.com
Subject: bug#3888: Some variables get the wrong, platform-specific, documentation
Date: Mon, 20 Jul 2009 16:25:38 -0400	[thread overview]
Message-ID: <87ws63gkzh.fsf@stupidchicken.com> (raw)

> > I guess this is because term/pc-win.elc is now in SOME_MACHINE_LISP in
> > src/Makefile.in. (It was not there in Emacs 22.)
>
> None of the *-win.elc files was in SOME_MACHINE_LISP in Emacs 22,
> which is why documentation of several important functions and
> variables were not in etc/DOC.  But there were other platform-specific
> files in SOME_MACHINE_LISP: dos-fns.elc, w32-fns.elc, vmsproc.elc,
> etc.  So the problem is not new.
>
> I think this calls for some infrastructure that is currently missing:
> how to define a platform-specific implementation of an API without
> clobbering the doc string for other platforms.  Maybe some markup in
> the doc string that would allow to have platform-specific parts there?

I think, as a temporary solution, we should make the docstrings of all
the affected functions and variables the same.  If necessary, they can
say somehthing like, "On Windows, this does X.  On Nexstep, this does
Y", and so on.





             reply	other threads:[~2009-07-20 20:25 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-07-20 20:25 Chong Yidong [this message]
2009-07-21  3:12 ` bug#3888: Some variables get the wrong, platform-specific, documentation 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
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

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

  git send-email \
    --in-reply-to=87ws63gkzh.fsf@stupidchicken.com \
    --to=cyd@stupidchicken.com \
    --cc=3888@emacsbugs.donarmstrong.com \
    --cc=eliz@gnu.org \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.