GNU bug report logs - #19942
25.0.50.1; Changing reftex-include-file-commands has no effect

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 19942 in the body.
You can then email your comments to 19942 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: Nicolas Richard <theonewiththeevillook <at> yahoo.fr>
To: bug-auctex <at> gnu.org, bug-gnu-emacs <at> gnu.org
Subject: 25.0.50.1; Changing reftex-include-file-commands has no effect
Date: Wed, 25 Feb 2015 10:17:14 +0100

Hello,

I was working in this document, wondering why reftex was not finding its
files. I realized it was because I was using a macro of mine (named
newpageinput) instead of the usual \input/\include, so I added:
% reftex-include-file-commands: ("newpageinput" "input" "include")
in the Local Variables: section, and hit C-u C-c C-n.

But despite my efforts (e.g. removing the corresponding style file in
auto/), the "C-c )" (reftex-reference) menu was always empty.

After some grepping, I finally found I had to run M-:
(reftex-compile-variables) RET in order to make it work.

Could this process be documented e.g. in the docstring of
reftex-include-file-commands ? Also, it would be nice to mention the
option reftex-include-file-commands in (info "(auctex) Multifile") or
(info "(reftex) Multifile Documents").

Thanks,


Emacs  : GNU Emacs 25.0.50.1 (i686-pc-linux-gnu, X toolkit, Xaw scroll bars)
 of 2015-02-18 on LDLC-portable
Package: 25.0.50.1

current state:
==============
(setq
 window-system 'x
 reftex-plug-into-AUCTeX t
 )

-- 
Nicolas Richard

Message #10 received at 19942-done <at> debbugs.gnu.org (full text, mbox):

From: Tassilo Horn <tsdh <at> gnu.org>
To: Nicolas Richard <theonewiththeevillook <at> yahoo.fr>
Cc: 19942-done <at> debbugs.gnu.org
Subject: Re: bug#19942: 25.0.50.1;
 Changing reftex-include-file-commands has no effect
Date: Wed, 25 Feb 2015 11:52:35 +0100

Nicolas Richard <theonewiththeevillook <at> yahoo.fr> writes:

Hi!

> I was working in this document, wondering why reftex was not finding
> its files. I realized it was because I was using a macro of mine
> (named newpageinput) instead of the usual \input/\include, so I added:
> % reftex-include-file-commands: ("newpageinput" "input" "include") in
> the Local Variables: section, and hit C-u C-c C-n.
>
> But despite my efforts (e.g. removing the corresponding style file in
> auto/), the "C-c )" (reftex-reference) menu was always empty.
>
> After some grepping, I finally found I had to run M-:
> (reftex-compile-variables) RET in order to make it work.
>
> Could this process be documented e.g. in the docstring of
> reftex-include-file-commands ?

The same applies to all parsing-related reftex variables.  When changing
these options with customized, the "reftex tables" are marked dirty and
`reftex-compile-variables' will be called appropriately [1].  When
changing the options from lisp, you have to do that on your own.

I added that to the docs.  Now they mention:

,----[ (info "(reftex)Options") ]
|    In case you don’t use the ‘customize’ interface, here’s a caveat:
| Changing (mostly parsing-related) options might require a call to
| ‘reftex-compile-variables’ in order to become effective.
`----

> Also, it would be nice to mention the option
> reftex-include-file-commands in (info "(auctex) Multifile") or (info
> "(reftex) Multifile Documents").

Now the latter has a new paragraph:

,----[ (info "(reftex)Multifile Documents") ]
|    • RefTeX knows about the ‘\include’ and ‘\input’ macros.  In case you
|      use different commands to include files in a multifile document,
|      customize the variable ‘reftex-include-file-commands’.
| 
`----

Bye,
Tassilo

[1] Actually, reftex-include-file-commands was an exception here.  I
added the appropriate :set property to the defcustom just now.

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

From: "Nicolas Richard" <theonewiththeevillook <at> yahoo.fr>
To: bug-auctex <at> gnu.org
Subject: Re: bug#19942: 25.0.50.1;
 Changing reftex-include-file-commands has no effect
Date: Wed, 25 Feb 2015 12:25:24 +0100

Hello Tassilo,

Tassilo Horn <tsdh <at> gnu.org> writes:
> The same applies to all parsing-related reftex variables.  When changing
> these options with customized, the "reftex tables" are marked dirty and
> `reftex-compile-variables' will be called appropriately [1].  When
> changing the options from lisp, you have to do that on your own.

(and later: )
> [1] Actually, reftex-include-file-commands was an exception here.  I
> added the appropriate :set property to the defcustom just now.

While I didn't mention it, I had checked for any customize-related
special-treatment, and hadn't found any, so thanks for [1] too !

> I added that to the docs.  Now they mention:
>
> ,----[ (info "(reftex)Options") ]
> |    In case you don’t use the ‘customize’ interface, here’s a caveat:
> | Changing (mostly parsing-related) options might require a call to
> | ‘reftex-compile-variables’ in order to become effective.
> `----

In fact I probably would not have noticed it, but then maybe it would
have been my fault for not searching the manual. I tend to rely mainly
on docstrings. This is a bad habit, as I've already noticed on other
occasions.

> Now the latter has a new paragraph:
>
> ,----[ (info "(reftex)Multifile Documents") ]
> |    • RefTeX knows about the ‘\include’ and ‘\input’ macros.  In case you
> |      use different commands to include files in a multifile document,
> |      customize the variable ‘reftex-include-file-commands’.
> | 
> `----

Great.

Thanks for your help,

-- 
Nicolas Richard

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

From: "Nicolas Richard" <theonewiththeevillook <at> yahoo.fr>
To: bug-auctex <at> gnu.org
Subject: Re: bug#19942: 25.0.50.1;
 Changing reftex-include-file-commands has no effect
Date: Wed, 25 Feb 2015 12:28:07 +0100

Tassilo Horn <tsdh <at> gnu.org> writes:
> Nicolas Richard <theonewiththeevillook <at> yahoo.fr> writes:
>> % reftex-include-file-commands: ("newpageinput" "input" "include") in
>                                                            When changing
> these options with customized, the "reftex tables" are marked dirty and
> `reftex-compile-variables' will be called appropriately [1].

Now that I actually think about it : does this means setting
reftex-include-file-commands as a file local variable will in fact never
work right without further adjustement ?

-- 
Nicolas Richard

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

From: Tassilo Horn <tsdh <at> gnu.org>
To: "Nicolas Richard" <theonewiththeevillook <at> yahoo.fr>
Cc: 19942 <at> debbugs.gnu.org
Subject: Re: bug#19942: 25.0.50.1;
 Changing reftex-include-file-commands has no effect
Date: Wed, 25 Feb 2015 13:09:42 +0100

"Nicolas Richard" <theonewiththeevillook <at> yahoo.fr> writes:

>> When changing these options with customized, the "reftex tables" are
>> marked dirty and `reftex-compile-variables' will be called
>> appropriately [1].
>
> Now that I actually think about it : does this means setting
> reftex-include-file-commands as a file local variable will in fact
> never work right without further adjustement ?

I've just tested and sadly the answer is yes.  You need to use

--8<---------------cut here---------------start------------->8---
%% Local Variables:
%% reftex-include-file-command: ("include" "input" "newpageinput")
%% eval: (reftex-compile-variables)
%% End:
--8<---------------cut here---------------end--------------->8---

Bye,
Tassilo

Previous Next

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