From: Eli Zaretskii <eliz@gnu.org>
To: Glenn Morris <rgm@gnu.org>, 3888@emacsbugs.donarmstrong.com
Subject: bug#3888: Some variables get the wrong, platform-specific, documentation
Date: Mon, 20 Jul 2009 21:56:38 +0300 [thread overview]
Message-ID: <83tz17npy1.fsf@gnu.org> (raw)
In-Reply-To: <qrr5wbxlkj.fsf@fencepost.gnu.org>
> From: Glenn Morris <rgm@gnu.org>
> Date: Mon, 20 Jul 2009 14:21:00 -0400
> Cc:
>
>
> In GNU Emacs 23.0.96.1 on GNU/Linux:
>
> emacs -Q
> C-h v x-select-enable-clipboard
>
> x-select-enable-clipboard is a variable defined in `x-win.el'.
> Its value is nil
>
> Documentation:
> Non-nil means cutting and pasting uses the clipboard.
> This is the default on this system, since MS-Windows does not
> support other types of selections.
>
> 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.
> Similarly, from ns-win.el, we get the following in GNU/Linux under X:
>
> x-display-name:
> The name of the Nextstep display on which Emacs was started.
>
> x-setup-function-keys:
> Set up function Keys for Nextstep for frame FRAME.
>
> x-select-text:
> Put TEXT, a string, on the pasteboard.
>
> x-colors:
> The list of colors defined in non-PANTONE color files.
>
> xw-defined-colors:
> Return a list of colors supported for a particular frame.
> The argument FRAME specifies which frame to try.
> The value may be different for frames on different Nextstep displays.
Similarly (but for slightly different reasons), in the Windows port:
x-set-selection is a compiled Lisp function in `w32-fns.el'.
(x-set-selection type data)
Not documented.
and the same for x-get-selection and x-selection-owner, even though
there's a doc string for all of these in the X-specific files.
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?
next prev parent reply other threads:[~2009-07-20 18:56 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <83k51y3up4.fsf@gnu.org>
2009-07-20 18:21 ` bug#3888: Some variables get the wrong, platform-specific, documentation Glenn Morris
2009-07-20 18:56 ` Eli Zaretskii [this message]
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
2009-07-20 20:25 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
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=83tz17npy1.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=3888@emacsbugs.donarmstrong.com \
--cc=rgm@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.