]> code.delx.au - gnu-emacs-elpa/blobdiff - packages/ada-mode/ada-mode.texi
Merge commit '2c744815cf9e4653625dd25f2e7f8b59c152782d' from js2-mode
[gnu-emacs-elpa] / packages / ada-mode / ada-mode.texi
old mode 100755 (executable)
new mode 100644 (file)
index 06e0d41..730b06a
@@ -26,11 +26,7 @@ developing GNU and promoting software freedom.''
 
 @titlepage
 @sp 10
 
 @titlepage
 @sp 10
-@title Ada Mode
-@sp 2
-@subtitle An Emacs major mode for programming in Ada
-@subtitle Ada Mode Version 5.1.5
-@sp 2
+@title Ada Mode Version 5.1.6
 @page
 @vskip 0pt plus 1filll
 @insertcopying
 @page
 @vskip 0pt plus 1filll
 @insertcopying
@@ -121,12 +117,21 @@ in the distribution.
 To see what version of Ada mode you have installed, invoke @kbd{M-x
 ada-mode-version}.
 
 To see what version of Ada mode you have installed, invoke @kbd{M-x
 ada-mode-version}.
 
+You may also want to install additional utilities:
+
 @menu
 @menu
+* Ada Reference Manual::
 * gnatinspect::
 * gnatinspect::
+* gpr_query::
 * Upgrading::
 @end menu
 
 * Upgrading::
 @end menu
 
-@node gnatinspect, Upgrading, Installation, Installation
+@node Ada Reference Manual
+@section Ada Reference Manual
+The ELPA package ada-ref-man includes the Ada Reference Manual and
+Annotated Ada Reference Manual in info format.
+
+@node gnatinspect, gpr_query, Installation, Installation
 @section gnatinspect
 Ada mode has experimental support for the new AdaCore cross reference
 tool @code{gnatinspect}, which supports Ada, C, C++, and any other
 @section gnatinspect
 Ada mode has experimental support for the new AdaCore cross reference
 tool @code{gnatinspect}, which supports Ada, C, C++, and any other
@@ -156,7 +161,18 @@ cd gnatcoll-1.7w-src/src/sqlite/amalgamation/
 gcc -O2 -o sqlite3 shell.c sqlite3.c -ldl -lpthread
 @end example
 
 gcc -O2 -o sqlite3 shell.c sqlite3.c -ldl -lpthread
 @end example
 
-@node Upgrading,  , gnatinspect, Installation
+@node gpr_query, Upgrading, gnatinspect, Installation
+@section gpr_query
+@file{gpr_query} is similar to @file{gnatinspect}, but customized for
+Emacs ada-mode use. To install it, install @file{gnatinspect} as above
+(@ref{gnatinspect}), then:
+
+@example
+cd ~/.emacs.d/elpa/ada-mode-5.xx/build
+make install-gpr_query
+@end example
+
+@node Upgrading,  , gpr_query, Installation
 @section Upgrading from previous versions
 
 See the file NEWS for more details; here we summarize only important
 @section Upgrading from previous versions
 
 See the file NEWS for more details; here we summarize only important
@@ -260,13 +276,25 @@ The project variable @code{ada_xref} (default elisp variable
 the cross-reference-tool-specific functions for corresponding Ada mode
 operations.
 
 the cross-reference-tool-specific functions for corresponding Ada mode
 operations.
 
-To use a cross reference tool other than gnatxref, you must write
+The default cross-reference tool is @file{gnatxref}, provided by the
+file @file{ada-gnat-xref.el}. Two other tools are supported:
+@file{gnat_inspect} and @file{gpr_query}. To use these, add one of the
+following to @file{~/.emacs}:
+
+@example
+(require 'gnat-inspect)
+(require 'gpr-query)
+@end example
+
+To use @file{gpr_query}, the Ada code @file{gpr_query.adb} must be
+compiled; see @ref{Installation}.
+
+To use a cross reference tool other than the above, you must write
 Emacs lisp code that provides the interface to the compiler, and set
 Emacs lisp code that provides the interface to the compiler, and set
-@code{ada-xref-tool} and the indirection variables. This has already
-been done for @code{gnatinspect}; set @code{ada-xref-tool} to
-@code{'gnat_inspect}.
+@code{ada-xref-tool} and the indirection variables.
 
 
-See @file{ada-gnat-xref.el} and @file{gnat-inspect.el} for examples.
+See @file{ada-gnat-xref.el}, @file{gnat-inspect.el},
+@file{gpr-query.el} for examples.
 
 @node Other customization,  , Other cross-reference, Customization
 @section Other customization
 
 @node Other customization,  , Other cross-reference, Customization
 @section Other customization
@@ -1543,7 +1571,7 @@ file specifies the casing of one word or word fragment. If an
 exception is defined in multiple files, the first occurrence is used.
 
 If the word starts with an asterisk (@code{*}), it defines the casing
 exception is defined in multiple files, the first occurrence is used.
 
 If the word starts with an asterisk (@code{*}), it defines the casing
-of a word fragemnt (or ``substring''); part of a word between two
+of a word fragment (or ``substring''); part of a word between two
 underscores or word boundary.
 
 For example:
 underscores or word boundary.
 
 For example: