Skip to content

Commit 43285bd

Browse files
committed
texinfo manuals: fix obsolete @Inforef
In most cases, this is a simple replacement, using @pxref in most cases.
1 parent 7873db1 commit 43285bd

File tree

2 files changed

+26
-23
lines changed

2 files changed

+26
-23
lines changed

doc/PG-adapting.texi

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ prototype is about 25 simple settings.
270270
For more advanced features you may need (or want) to write some Emacs
271271
Lisp. If you're adding new functionality please consider making it
272272
generic for different proof assistants, if appropriate. When writing
273-
your modes, please follow the Emacs Lisp conventions, @inforef{Tips, ,Elisp}.
273+
your modes, please follow the Emacs Lisp conventions, @pxref{Tips,,,Elisp}.
274274

275275
The configuration variables are declared in the file
276276
@file{generic/proof-config.el}. The details in the central part of this
@@ -667,7 +667,7 @@ Note that for the generic functions to work properly, it is
667667
@strong{essential} that you set the syntax table for your mode properly,
668668
so that comments and strings are recognized. See the Emacs
669669
documentation to discover how to do this (particularly for the function
670-
@code{modify-syntax-entry}, (@inforef{Syntax Tables, ,Elisp}).
670+
@code{modify-syntax-entry}, (@pxref{Syntax Tables,,,Elisp}).
671671

672672
@xref{Proof script mode}, for more details of the parsing
673673
functions.
@@ -730,7 +730,7 @@ or @samp{@code{proof-script-parse-function}}.
730730
The next four settings configure the comment syntax. Notice that to get
731731
reliable behaviour of the parsing functions, you may need to modify the
732732
syntax table for your prover's mode.
733-
Read the Elisp manual (@inforef{Syntax Tables, ,Elisp}) for details about that.
733+
Read the Elisp manual (@pxref{Syntax Tables,,,Elisp}) for details about that.
734734

735735
@c TEXI DOCSTRING MAGIC: proof-script-comment-start
736736
@defvar proof-script-comment-start
@@ -1148,9 +1148,9 @@ consistency. Portions that can be potentially omitted are called
11481148
@emph{opaque proofs} in Proof General, because usually only
11491149
opaque proofs (in the sense of Coq) can be omitted without
11501150
risking to break the following code. This feature is also
1151-
described in the Proof General manual, @inforef{Script processing
1152-
commands, ,ProofGeneral} and @inforef{Omitting proofs for speed,
1153-
,ProofGeneral}.
1151+
described in the Proof General manual, @pxref{Script processing
1152+
commands,,,ProofGeneral} and
1153+
@pxref{Omitting proofs for speed,,,ProofGeneral}.
11541154

11551155
The omit proofs feature works in a simple, straightforward way:
11561156
After parsing the asserted region, Proof General uses regular
@@ -2519,7 +2519,8 @@ advantage of not requiring the underlying text to be changed to display
25192519
symbols.
25202520

25212521
Usage of the Unicode Tokens package is described in the Proof General
2522-
user manual, @inforef{Unicode support, ,ProofGeneral}.
2522+
user manual, @pxref{Unicode symbols and special layout
2523+
support,,,ProofGeneral}.
25232524

25242525
@c FIXME TODO: add documentation here to explain config of Unicode Tokens
25252526

doc/ProofGeneral.texi

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -743,7 +743,7 @@ of a common interface mechanism.
743743
To get more from Proof General and adapt it to your liking, it helps to
744744
know a little bit about how Emacs lisp packages can be customized via
745745
the Customization mechanism. It's really easy to use. For details,
746-
@pxref{How to customize}. @inforef{Customization, ,emacs},
746+
@pxref{How to customize}. @xref{Customization,,,emacs},
747747
for documentation in Emacs.
748748

749749
To get the absolute most from Proof General, to improve it or to adapt
@@ -1622,7 +1622,7 @@ As experienced Emacs users will know, a @i{prefix argument} is a numeric
16221622
argument supplied by some key sequence typed before a command key
16231623
sequence. You can supply a specific number by typing @key{Meta} with
16241624
the digits, or a ``universal'' prefix of @kbd{C-u}. See
1625-
@inforef{Arguments, ,emacs} for more details. Several Proof General
1625+
@ref{Arguments,,,emacs} for more details. Several Proof General
16261626
commands, like @code{proof-retract-until-point-interactive}, may accept
16271627
a @i{prefix argument} to adjust their behaviour somehow.
16281628

@@ -2927,7 +2927,7 @@ This is an inherent problem with outline because it works by modifying
29272927
the buffer. If you want to use outline with processed scripts, you
29282928
can turn off the @code{Strict Read Only} option.
29292929

2930-
See @inforef{Outline Mode, ,emacs} for more information about outline mode.
2930+
See @ref{Outline Mode,,,emacs} for more information about outline mode.
29312931

29322932
@node Support for completion
29332933
@section Support for completion
@@ -3023,7 +3023,7 @@ General doesn't do this automatically.
30233023
Apart from completion, there are several other operations on tags. One
30243024
common one is replacing identifiers across all files using
30253025
@code{tags-query-replace}. For more information on how to use tags,
3026-
@inforef{Tags, ,emacs}.
3026+
@pxref{xref,,,emacs}.
30273027

30283028
To use tags for completion at the same time as the completion mechanism
30293029
mentioned already, you can use the command @kbd{M-x add-completions-from-tags-table}.
@@ -3379,7 +3379,7 @@ Proof General has been fully loaded. Proof General is fully loaded when
33793379
you visit a script file for the first time, or if you type @kbd{M-x
33803380
load-library RET proof RET}.
33813381

3382-
For more help with customize, see @inforef{Customization, ,emacs}.
3382+
For more help with customize, see @ref{Customization,,,emacs}.
33833383

33843384

33853385

@@ -4100,7 +4100,7 @@ and a short-cut for enabling three window mode,
41004100
@cindex file variables
41014101

41024102
A very convenient way to customize file-specific variables is to use
4103-
File Variables (@inforef{File Variables, ,emacs}). This feature of
4103+
File Variables (@pxref{File Variables,,,emacs}). This feature of
41044104
Emacs permits to specify values for certain Emacs variables
41054105
when a file is loaded. File variables and their values
41064106
are written as a list at the end of
@@ -4144,13 +4144,13 @@ And then the right call to make will be done if you use the @kbd{M-x
41444144
compile} command, and the correct @code{coqtop} will be called by
41454145
ProofGeneral. Note that the lines are commented in order to be ignored
41464146
by the proof assistant. It is possible to use this mechanism for all
4147-
variables, @inforef{File Variables, ,emacs}.
4147+
variables, @pxref{File Variables,,,emacs}.
41484148

41494149
@emph{NOTE:} @code{coq-prog-name} should contain only the @code{coqtop}
41504150
executable, @emph{not the options}.
41514151

41524152
One can also specify file variables on a per directory basis,
4153-
@inforef{Directory Variables, ,emacs}. You can achieve almost the same
4153+
@pxref{Directory Variables,,,emacs}. You can achieve almost the same
41544154
as above for all the files of a directory by storing
41554155

41564156
@lisp
@@ -4161,7 +4161,7 @@ as above for all the files of a directory by storing
41614161
into the file @code{.dir-locals.el} in one of the parent directories.
41624162
The value in this file must be an alist that maps mode names to alists,
41634163
where these latter alists map variables to values. You can aso put
4164-
arbitrary code in this file @inforef{Directory Variables, ,emacs}.
4164+
arbitrary code in this file @pxref{Directory Variables,,,emacs}.
41654165

41664166
@emph{Note:} if you add such content to the @code{.dir-locals.el} file
41674167
you should restart Emacs or revert your buffer.
@@ -4170,7 +4170,7 @@ you should restart Emacs or revert your buffer.
41704170
@section Using abbreviations
41714171

41724172
A very useful package of Emacs supports automatic expansions of
4173-
abbreviations as you type, @inforef{Abbrevs, ,emacs}.
4173+
abbreviations as you type, @pxref{Abbrevs,,,emacs}.
41744174

41754175
For example, the proof assistant Coq has many command strings that are
41764176
long, such as ``reflexivity,'' ``Inductive,'' ``Definition'' and
@@ -4314,10 +4314,12 @@ with the option @code{coq-load-path}, but this is not compatible
43144314
with @code{CoqIde} or @code{coq_makefile}.
43154315

43164316
@emph{NOTE:} the Coq project file cannot define which version of
4317-
@code{coqtop} is launched. You need either to launch emacs with the
4318-
right executable in the path or use @inforef{File Variables, ,emacs} or
4319-
@inforef{Directory Variables, ,emacs}. See @ref{Using file variables}
4320-
below.
4317+
@code{coqtop} is launched. @xref{Opam-switch-mode support} for how to
4318+
switch between different Coq versions. Alternatively, for a fixed
4319+
version, you need either to launch emacs with the right executable in
4320+
the path or use file variables (@pxref{Using file variables} below or
4321+
@pxref{File Variables,,,emacs}) or directory variables,
4322+
@pxref{Directory Variables,,,emacs}.
43214323

43224324
@menu
43234325
* Changing the name of the coq project file::
@@ -4338,7 +4340,7 @@ If you only want to change the name of the Coq project file for
43384340
one project you can set the option as local file variable,
43394341
@ref{Using file variables}. This can be done either directly in
43404342
every file or once for all files of a directory tree with a
4341-
@code{.dir-locals.el} file, @inforef{Directory Variables, ,emacs}.
4343+
@code{.dir-locals.el} file, @pxref{Directory Variables,,,emacs}.
43424344
The file @code{.dir-locals.el} should then contain
43434345

43444346
@lisp
@@ -4543,7 +4545,7 @@ Output from the compilation is only shown in case
45434545
of errors. It then appears in the buffer
45444546
@code{*coq-compile-response*}.
45454547
One can use @code{C-x `} (bound to @code{next-error},
4546-
@inforef{Compilation Mode,,emacs}) to jump to error locations.
4548+
@pxref{Compilation Mode,,,emacs}) to jump to error locations.
45474549
Sometimes the compilation commands do not produce error messages
45484550
with location information, then @code{C-x `} does only work in a
45494551
limited way.

0 commit comments

Comments
 (0)