unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Glenn Morris <rgm@gnu.org>
To: bug-gnu-emacs@gnu.org
Subject: bug#4402: apropos-documentation and platform-specific docs
Date: Fri, 11 Sep 2009 03:01:04 -0400	[thread overview]
Message-ID: <bcfxauvubz.fsf@fencepost.gnu.org> (raw)


On GNU/Linux:
emacs -Q
M-x apropos-documentation nextstep

returns various matches, including things like:

x-create-frame
  Function: Make a new Nextstep window, called a "frame" in Emacs terms.
[...]

The one-line summary is incorrect, since it is the version specific to
the NS build, not the build currently running.

The problem is caused by the DOC file containing three sets of
doc-strings for Fx-create-frame, extracted from w32fns.c, xfns.c, and
nsfns.m.

This made me wonder, why does the DOC file in my GNU/Linux build
contain information extracted from Nextstep and Windows files that is
never going to be relevant? Perhaps it's so that one can in principle
share DOC files between different builds? This doesn't seem like a big
advantage to me. I doubt (m)any people have ever shared the DOC file
between any of these platforms. The size of DOC is a negligible part of
a current Emacs installation.

The standard solution to this kind of thing seems to be that where
functions/variables have multiple, platform-specific definitions, each
should have the same, unified doc-string. This is a bit of a pain.

Only putting the relevant files into the DOC file would eliminate this
issue.






             reply	other threads:[~2009-09-11  7:01 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-09-11  7:01 Glenn Morris [this message]
2009-09-11  9:02 ` bug#4402: apropos-documentation and platform-specific docs Eli Zaretskii
2009-09-11 18:05   ` Glenn Morris
2009-09-12  8:55     ` Eli Zaretskii
2009-09-12 19:45       ` Stefan Monnier
     [not found]         ` <os1vmatjml.fsf@fencepost.gnu.org>
2009-09-14  1:20           ` Processed: " Emacs bug Tracking System
2017-12-04  3:05           ` Glenn Morris
2009-09-11 19:04 ` Stefan Monnier

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=bcfxauvubz.fsf@fencepost.gnu.org \
    --to=rgm@gnu.org \
    --cc=4402@emacsbugs.donarmstrong.com \
    --cc=bug-gnu-emacs@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 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).