all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* bug#3888: Some variables get the wrong, platform-specific, documentation
@ 2009-07-20 20:25 Chong Yidong
  2009-07-21  3:12 ` Eli Zaretskii
  2009-07-21 16:18 ` Stefan Monnier
  0 siblings, 2 replies; 11+ messages in thread
From: Chong Yidong @ 2009-07-20 20:25 UTC (permalink / raw)
  To: Eli Zaretskii; +Cc: 3888

> > 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.





^ permalink raw reply	[flat|nested] 11+ messages in thread
* bug#3888: Re: bug#3888: Some variables get the wrong, platform-specific, documentation
@ 2009-07-20 21:33 Chong Yidong
  2009-07-21 18:59 ` Eli Zaretskii
  0 siblings, 1 reply; 11+ messages in thread
From: Chong Yidong @ 2009-07-20 21:33 UTC (permalink / raw)
  To: Eli Zaretskii; +Cc: 3888

As a work-around, I changed the affected doc-strings so that the
different versions all say the same thing.  Eli, could you check if this
works OK on Windows?

Right now, this change is only on the branch.  I'll check this into the
trunk, at a later date, only if we can't come up with a better solution.





^ permalink raw reply	[flat|nested] 11+ messages in thread
[parent not found: <83k51y3up4.fsf@gnu.org>]

end of thread, other threads:[~2009-07-24 17:41 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
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

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.