GNU bug report logs - #11565
delayed init variables don't get documentation properties

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 11565 in the body.
You can then email your comments to 11565 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #3 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: submit <at> debbugs.gnu.org
Subject: delayed init variables don't get documentation properties
Date: Sat, 26 May 2012 18:29:54 -0400

Package: emacs
Version: 24.1.50

Current trunk:

emacs -Q
C-h v Info-default-directory-list
  -> Not documented as a variable.

The doc string is in the DOC file though.

I think this is because:

1) it's a preloaded defcustom using custom-initialize-delay

2) custom-initialize-delay keeps variables unbound until they are
initialized. There's a comment about this in the source: "This seemed to
be at least as good as setting it to an arbitrary value like nil".

3) Snarf-documentation (semi-recently; bug#11036) ignores unbound
variables, on the assumption that they are for other platforms (eg
w32-specific).


I guess either we undo 3), or change 2) so that it sets the variable to
nil. The latter seems ok to me ...?

Message #6 received at 11565 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 11565 <at> debbugs.gnu.org
Subject: Re: bug#11565: delayed init variables don't get documentation
	properties
Date: Sun, 27 May 2012 09:00:03 -0400

> I guess either we undo 3), or change 2) so that it sets the variable to
> nil.  The latter seems ok to me ...?

Undoing the var-part of 3 sounds fine to me.


        Stefan

Message #9 received at 11565 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 11565 <at> debbugs.gnu.org
Subject: Re: bug#11565: delayed init variables don't get documentation
	properties
Date: Mon, 28 May 2012 15:53:29 -0400

Stefan Monnier wrote:

>> I guess either we undo 3), or change 2) so that it sets the variable to
>> nil.  The latter seems ok to me ...?
>
> Undoing the var-part of 3 sounds fine to me.

There's a downside to doing that, in that bug#11036 will be reopened.
What's the downside to making custom-initialize-delay temporarily bind
variables to nil?

Another option: Snarf-documentation to check if variables are bound, or
members of custom-delayed-init-variables.

Message #12 received at 11565 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 11565 <at> debbugs.gnu.org
Subject: Re: bug#11565: delayed init variables don't get documentation
	properties
Date: Mon, 28 May 2012 15:56:51 -0400

PS this issue will presumably go away if you go through with
http://lists.gnu.org/archive/html/emacs-devel/2012-05/msg00474.html

and stop keeping the docs of preloaded lisp files in DOC.

Message #15 received at 11565 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 11565 <at> debbugs.gnu.org
Subject: Re: bug#11565: delayed init variables don't get documentation
	properties
Date: Mon, 28 May 2012 16:27:42 -0400

>>> I guess either we undo 3), or change 2) so that it sets the variable to
>>> nil.  The latter seems ok to me ...?
>> Undoing the var-part of 3 sounds fine to me.
> There's a downside to doing that, in that bug#11036 will be reopened.

It doesn't strike me as a serious problem.

> What's the downside to making custom-initialize-delay temporarily bind
> variables to nil?

The downside is that I don't know the consequences ;-)

> Another option: Snarf-documentation to check if variables are bound, or
> members of custom-delayed-init-variables.

Yuck.

> PS this issue will presumably go away if you go through with
> http://lists.gnu.org/archive/html/emacs-devel/2012-05/msg00474.html

That's likely to happen, indeed.


        Stefan

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.