GNU bug report logs - #36670
27.0.50; Wishlist: describe-face should use the new help-buffer infrastructure

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 36670 in the body.
You can then email your comments to 36670 AT debbugs.gnu.org in the normal way.

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

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.0.50; Wishlist: describe-face should use the new help-buffer
 infrastructure
Date: Mon, 15 Jul 2019 18:14:52 +0200

M-x describe-variable (and -function) uses a new infrastructure based on
help-fns-describe-{variable,function}-functions that registers a bunch
of little bits to be output, which gives more flexibility.

describe-face should use the same thing, and be moved to help-fns.el.


In GNU Emacs 27.0.50 (build 2, x86_64-pc-linux-gnu, GTK+ Version 3.22.30)
 of 2019-07-15 built on sandy
Repository revision: d0e558c0025b295bbd8c51122600d1083ed6d391
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.11906000
System Description: Ubuntu 18.04.2 LTS


-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: 36670 <at> debbugs.gnu.org
Subject: Re: bug#36670: 27.0.50; Wishlist: describe-face should use the new
 help-buffer infrastructure
Date: Sat, 21 Sep 2019 00:48:09 +0200

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> M-x describe-variable (and -function) uses a new infrastructure based on
> help-fns-describe-{variable,function}-functions that registers a bunch
> of little bits to be output, which gives more flexibility.
>
> describe-face should use the same thing, and be moved to help-fns.el.

I have now done this on the trunk, as previously requested by Stefan M.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 36670 <at> debbugs.gnu.org
Subject: Re: bug#36670: 27.0.50;
 Wishlist: describe-face should use the new help-buffer infrastructure
Date: Sat, 21 Sep 2019 09:41:51 +0300

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Date: Sat, 21 Sep 2019 00:48:09 +0200
> 
> Lars Ingebrigtsen <larsi <at> gnus.org> writes:
> 
> > M-x describe-variable (and -function) uses a new infrastructure based on
> > help-fns-describe-{variable,function}-functions that registers a bunch
> > of little bits to be output, which gives more flexibility.
> >
> > describe-face should use the same thing, and be moved to help-fns.el.
> 
> I have now done this on the trunk, as previously requested by Stefan M.

What does this mean in practice?  I see nothing about this in NEWS or
in the manuals, which makes me wonder how is this "more flexible".  I
guess there were some discussions, but neither the log message nor the
bug discussion mentions any other sources of information.  Could you
please point to those discussions, or fill the void by explaining what
additional flexibility do we gain?  This is for future forensics, if
for nothing else.

Thanks.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 36670 <at> debbugs.gnu.org
Subject: Re: bug#36670: 27.0.50; Wishlist: describe-face should use the new
 help-buffer infrastructure
Date: Sat, 21 Sep 2019 09:44:51 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

> What does this mean in practice?  I see nothing about this in NEWS or
> in the manuals, which makes me wonder how is this "more flexible".  I
> guess there were some discussions, but neither the log message nor the
> bug discussion mentions any other sources of information.  Could you
> please point to those discussions, or fill the void by explaining what
> additional flexibility do we gain?  This is for future forensics, if
> for nothing else.

I don't think this was discussed much at all -- it relates to the
rewrite Stefan did in April, and he mentioned (in a comment to a fix to
`describe-face') that that function should be rewritten in a similar way.

commit 896e5802160c2797e689a7565599ebb1bd171295
Author: Stefan Monnier <monnier <at> iro.umontreal.ca>
Date:   Fri Apr 12 12:37:00 2019 -0400

    * lisp/help-fns.el (help-fns-describe-variable-functions): New hook
    
    (help-fns--compiler-macro, help-fns--parent-mode, help-fns--obsolete)
    (help-fns--interactive-only): Indent output by 2 spaces.
    (help-fns--side-effects): New function extracted from
    describe-function-1.
    (help-fns-describe-function-functions): Use it.
    (help-fns--first-release, help-fns--mention-first-release): New functions.
    (help-fns-function-description-header): Keymaps and macros can't
    be interactive.
    (help-fns--ensure-empty-line): New function.
    (describe-function-1): Use it.
    (help-fns--var-safe-local, help-fns--var-risky)
    (help-fns--var-ignored-local, help-fns--var-file-local)
    (help-fns--var-watchpoints, help-fns--var-obsolete)
    (help-fns--var-alias, help-fns--var-bufferlocal): New functions,
    extacted from describe-variable.
    (describe-variable): Run help-fns-describe-variable-functions instead.


-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 36670 <at> debbugs.gnu.org
Subject: Re: bug#36670: 27.0.50; Wishlist: describe-face should use the new
 help-buffer infrastructure
Date: Sat, 21 Sep 2019 11:22:33 +0300

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Cc: 36670 <at> debbugs.gnu.org
> Date: Sat, 21 Sep 2019 09:44:51 +0200
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > What does this mean in practice?  I see nothing about this in NEWS or
> > in the manuals, which makes me wonder how is this "more flexible".  I
> > guess there were some discussions, but neither the log message nor the
> > bug discussion mentions any other sources of information.  Could you
> > please point to those discussions, or fill the void by explaining what
> > additional flexibility do we gain?  This is for future forensics, if
> > for nothing else.
> 
> I don't think this was discussed much at all -- it relates to the
> rewrite Stefan did in April, and he mentioned (in a comment to a fix to
> `describe-face') that that function should be rewritten in a similar way.
> 
> commit 896e5802160c2797e689a7565599ebb1bd171295
> Author: Stefan Monnier <monnier <at> iro.umontreal.ca>
> Date:   Fri Apr 12 12:37:00 2019 -0400
> 
>     * lisp/help-fns.el (help-fns-describe-variable-functions): New hook
>     
>     (help-fns--compiler-macro, help-fns--parent-mode, help-fns--obsolete)
>     (help-fns--interactive-only): Indent output by 2 spaces.
>     (help-fns--side-effects): New function extracted from
>     describe-function-1.
>     (help-fns-describe-function-functions): Use it.
>     (help-fns--first-release, help-fns--mention-first-release): New functions.
>     (help-fns-function-description-header): Keymaps and macros can't
>     be interactive.
>     (help-fns--ensure-empty-line): New function.
>     (describe-function-1): Use it.
>     (help-fns--var-safe-local, help-fns--var-risky)
>     (help-fns--var-ignored-local, help-fns--var-file-local)
>     (help-fns--var-watchpoints, help-fns--var-obsolete)
>     (help-fns--var-alias, help-fns--var-bufferlocal): New functions,
>     extacted from describe-variable.
>     (describe-variable): Run help-fns-describe-variable-functions instead.

So we are making changes without a good understanding what kind of
flexibility it gains us?

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Stefan Monnier <monnier <at> iro.umontreal.ca>, 36670 <at> debbugs.gnu.org
Subject: Re: bug#36670: 27.0.50; Wishlist: describe-face should use the new
 help-buffer infrastructure
Date: Sat, 21 Sep 2019 10:38:32 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

> So we are making changes without a good understanding what kind of
> flexibility it gains us?

Looking at the change, the flexibility seems kinda obvious -- the
humongous help functions are split into many smaller ones so that they
can be rearranged more easily? 

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: monnier <at> iro.umontreal.ca, 36670 <at> debbugs.gnu.org
Subject: Re: bug#36670: 27.0.50; Wishlist: describe-face should use the new
 help-buffer infrastructure
Date: Sat, 21 Sep 2019 12:05:06 +0300

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Cc: Stefan Monnier <monnier <at> iro.umontreal.ca>,  36670 <at> debbugs.gnu.org
> Date: Sat, 21 Sep 2019 10:38:32 +0200
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > So we are making changes without a good understanding what kind of
> > flexibility it gains us?
> 
> Looking at the change, the flexibility seems kinda obvious -- the
> humongous help functions are split into many smaller ones so that they
> can be rearranged more easily? 

So this is just a cleanup of the internals?

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: monnier <at> iro.umontreal.ca, 36670 <at> debbugs.gnu.org
Subject: Re: bug#36670: 27.0.50; Wishlist: describe-face should use the new
 help-buffer infrastructure
Date: Sat, 21 Sep 2019 11:10:39 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

> So this is just a cleanup of the internals?

Yes.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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