bug#29206: Make xref-show-xrefs-function a defcustom

bug#29206: Make xref-show-xrefs-function a defcustom

[Fritz Stelzer]

[-- Attachment #1: Type: text/plain, Size: 959 bytes --]

master c89870d7ef8b59febba9060f0da25b24403c2e08
Author:     brotzeit <brotzeitmacher@gmail.com>
AuthorDate: Wed Nov 8 10:39:57 2017 +0100
Commit:     brotzeit <brotzeitmacher@gmail.com>
CommitDate: Wed Nov 8 10:39:57 2017 +0100

Parent:     83dc3f0e9b * lisp/net/tramp-cmds.el, lisp/allout.el: Avoid
custom-set-variables
Merged:     master
Containing: master
Follows:    emacs-25.1 (130661)

Make xref-show-xrefs-function a defcustom

1 file changed, 3 insertions(+), 2 deletions(-)
lisp/progmodes/xref.el | 5 +++--

modified   lisp/progmodes/xref.el
@@ -738,8 +738,9 @@ xref--show-xref-buffer
 ;; The controversial multiple definitions case is handed off to
 ;; xref-show-xrefs-function.

-(defvar xref-show-xrefs-function 'xref--show-xref-buffer
-  "Function to display a list of xrefs.")
+(defcustom xref-show-xrefs-function 'xref--show-xref-buffer
+  "Function to display a list of xrefs."
+  :type 'function)

 (defvar xref--read-identifier-history nil)

[-- Attachment #2: Type: text/html, Size: 1239 bytes --]

bug#29206: Make xref-show-xrefs-function a defcustom

[Eli Zaretskii]

> From: Fritz Stelzer <brotzeitmacher@gmail.com>
> Date: Wed, 8 Nov 2017 10:43:29 +0100
> 
> master c89870d7ef8b59febba9060f0da25b24403c2e08
> Author:     brotzeit <brotzeitmacher@gmail.com>
> AuthorDate: Wed Nov 8 10:39:57 2017 +0100
> Commit:     brotzeit <brotzeitmacher@gmail.com>
> CommitDate: Wed Nov 8 10:39:57 2017 +0100
> 
> Parent:     83dc3f0e9b * lisp/net/tramp-cmds.el, lisp/allout.el: Avoid custom-set-variables
> Merged:     master
> Containing: master
> Follows:    emacs-25.1 (130661)
> 
> Make xref-show-xrefs-function a defcustom
> 
> 1 file changed, 3 insertions(+), 2 deletions(-)
> lisp/progmodes/xref.el | 5 +++--
> 
> modified   lisp/progmodes/xref.el
> @@ -738,8 +738,9 @@ xref--show-xref-buffer
>  ;; The controversial multiple definitions case is handed off to
>  ;; xref-show-xrefs-function.
>  
> -(defvar xref-show-xrefs-function 'xref--show-xref-buffer
> -  "Function to display a list of xrefs.")
> +(defcustom xref-show-xrefs-function 'xref--show-xref-buffer
> +  "Function to display a list of xrefs."
> +  :type 'function)
>  
>  (defvar xref--read-identifier-history nil)

Dmitry, any comments on this?  (If accepted, the defcustom should have
a :version tag.)

bug#29206: Make xref-show-xrefs-function a defcustom

[Dmitry Gutov]

On 11/18/17 12:14 PM, Eli Zaretskii wrote:

>> -(defvar xref-show-xrefs-function 'xref--show-xref-buffer
>> -  "Function to display a list of xrefs.")
>> +(defcustom xref-show-xrefs-function 'xref--show-xref-buffer
>> +  "Function to display a list of xrefs."
>> +  :type 'function)
>>   
>>   (defvar xref--read-identifier-history nil)
> 
> Dmitry, any comments on this?  (If accepted, the defcustom should have
> a :version tag.)

I don't really see the point, yet: we don't offer any alternative 
functions, and if the user is going to write one, `setq' is just as easy 
to do.

Further, applying this kind of minor change (and finding it important) 
seems like it would indicate that xref is kind of "stable", which it is 
not, so far.

bug#29206: Make xref-show-xrefs-function a defcustom

[Eli Zaretskii]

> Cc: 29206@debbugs.gnu.org
> From: Dmitry Gutov <dgutov@yandex.ru>
> Date: Sun, 19 Nov 2017 01:42:17 +0200
> 
> On 11/18/17 12:14 PM, Eli Zaretskii wrote:
> 
> >> -(defvar xref-show-xrefs-function 'xref--show-xref-buffer
> >> -  "Function to display a list of xrefs.")
> >> +(defcustom xref-show-xrefs-function 'xref--show-xref-buffer
> >> +  "Function to display a list of xrefs."
> >> +  :type 'function)
> >>   
> >>   (defvar xref--read-identifier-history nil)
> > 
> > Dmitry, any comments on this?  (If accepted, the defcustom should have
> > a :version tag.)
> 
> I don't really see the point, yet: we don't offer any alternative 
> functions, and if the user is going to write one, `setq' is just as easy 
> to do.
> 
> Further, applying this kind of minor change (and finding it important) 
> seems like it would indicate that xref is kind of "stable", which it is 
> not, so far.

Fine with me, then please close as "wontfix".

bug#29206: Make xref-show-xrefs-function a defcustom

[Dmitry Gutov]

On 11/19/17 5:28 PM, Eli Zaretskii wrote:

> Fine with me, then please close as "wontfix".

If you don't mind, I'd rather keep it open for now. And close it if the 
situation doesn't change, say, within the next development cycle.

bug#29206: Make xref-show-xrefs-function a defcustom

[Lars Ingebrigtsen]

Dmitry Gutov <dgutov@yandex.ru> writes:

> On 11/19/17 5:28 PM, Eli Zaretskii wrote:
>
>> Fine with me, then please close as "wontfix".
>
> If you don't mind, I'd rather keep it open for now. And close it if
> the situation doesn't change, say, within the next development cycle.

That was a year and a half ago -- what's your opinion now?

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

bug#29206: Make xref-show-xrefs-function a defcustom

[Dmitry Gutov]

On 24.06.2019 23:31, Lars Ingebrigtsen wrote:
> That was a year and a half ago -- what's your opinion now?

I'd be fine with it now. Though the surrounding code has changed a bit 
and the patch doesn't apply anymore.

The same change would need to be made for xref-show-definitions-function 
as well, I think.

bug#29206: Make xref-show-xrefs-function a defcustom

[Lars Ingebrigtsen]

Dmitry Gutov <dgutov@yandex.ru> writes:

> I'd be fine with it now. Though the surrounding code has changed a bit
> and the patch doesn't apply anymore.
>
> The same change would need to be made for
> xref-show-definitions-function as well, I think.

OK; I've now made these changes.

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

bug#29206: Make xref-show-xrefs-function a defcustom

[Dmitry Gutov]

On 25.06.2019 14:09, Lars Ingebrigtsen wrote:
> Dmitry Gutov <dgutov@yandex.ru> writes:
> 
>> I'd be fine with it now. Though the surrounding code has changed a bit
>> and the patch doesn't apply anymore.
>>
>> The same change would need to be made for
>> xref-show-definitions-function as well, I think.
> 
> OK; I've now made these changes.

Nice. Thank you.