File: README

package info (click to toggle)
ada-mode 3.6-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny, sarge
  • size: 680 kB
  • ctags: 369
  • sloc: lisp: 6,447; makefile: 54; sh: 50
file content (108 lines) | stat: -rw-r--r-- 3,707 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
README for Ada Mode
-----------------------------------

In this directory you find all the files to use Emacs for programming in
Ada.  There is also a manual in ada-mode.texi which has been updated
for the current release.  Please report any discrepancies between the
doc and the code.  Documentation bugs are as serious as code bugs.

This release was tested on Gnu Emacs 20.3 to GNU Emacs 21.0. It is known to
work with XEmacs 21.1.


Installation
------------

Installing the ada-mode is really easy. You have to know where
Emacs (or Xemacs) is installed on your system (for instance,
you can try a "wich emacs" command on your system).

We will suppose in the rest of this document that it is installed
in /usr/local/ on a UNIX system, or in c:\emacs on a Windows
system.

Copy the files *.el and *.elc from the current directory to
   
     /usr/local/share/emacs/site-lisp   on Unix
     c:\emacs\site-lisp                 on Windows

If you had a previous installation of the ada-mode (not the one
packaged with Emacs), you should edit the file site-start.el
in the same directory, and delete any the following lines if you
see them
    
    (load "ada-xref")
    (load "ada-prj")
    (require 'ada-xref)
    (require 'ada-prj)

This should be done also in your .emacs.

These are no longer required for the ada-mode.

If it is not already there, you might want to add the following line
either to your .emacs or to site-start.el (the system-wide configuration
file):

   (require 'ada-mode)
   (unless ada-xemacs
       (global-font-lock-mode t)
     (add-hook 'find-file-hooks 'turn-on-font-lock-if-enabled))

The second line will force Emacs to use color highlighting whenever
possible.


Troubleshooting
---------------

In case you get an error message when you start Emacs (something like
"Symbol's value as variable is void: ada-...."), this means that one
of Emacs's initialisation files in trying to read or set a variable
that has not yet been defined.
Try to add a (load "ada-mode") a the beginning of your .emacs. This will
load the ada-mode, and define all the variables.

If you have problems with the Ada mode, please make sure you are using the
correct version. For this, type the following from Emacs:
  M-x locate-library RET ada-mode RET
(M-x means press and release ESC, and then press x)
The result should be a directory called site-lisp. If it is not the case,
then it means that you are using an old version of the Ada mode, and that
Emacs is not able to find the correct files.
Try setting the following in your .emacs :

   (add-to-list 'load-path "directory/where/ada-mode/is/installed")


Documentation
---------------

For printing pass it through TeX with 'tex ada-mode.texi'.  This will
generate a 'ada-mode.dvi'.  Ask your sysadmin how to print dvi files
(usually with dvips).  I recently discovered texi2html.  This makes up
another nice way to see the documentation online. 

Files
-----

The main Ada mode is in ada-mode.el.  It contains the standard setup
with support routines for imenu, font-lock, and find-file.  Its principal
code contains the indenting functions.

As extensions to this mode you get an ada-stmt.el for statement
templates, ada-xref.el for using your Ada sources like a hyperlinked
document (show declarations of entities in another window), and
ada-prj.el to handle the projects files (see the documentation)

Bugs
----

If you have any problems, please report the bugs to
Emmanuel Briot <briot@gnat.com> with a subject line including 
'emacs ada mode'.
If you are a supported customer of Ada Core Technologies, please report 
your bugs to report@gnat.com in the usual manner so that they get priority
attention.

Have fun with Ada and Emacs