annotate src/m/template.h @ 108639:cfaca963d899

* src/[ms]/template.h: Comments.
author Glenn Morris <rgm@gnu.org>
date Mon, 17 May 2010 19:59:15 -0700
parents 6fcaca6266ae
children d268237e3481
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* machine description file template.
108506
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
2
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
3 Copyright (C) 1985, 1986, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
4 2008, 2009, 2010 Free Software Foundation, Inc.
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 This file is part of GNU Emacs.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7
94714
7e5b32f86a4c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79755
diff changeset
8 GNU Emacs is free software: you can redistribute it and/or modify
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 it under the terms of the GNU General Public License as published by
94714
7e5b32f86a4c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79755
diff changeset
10 the Free Software Foundation, either version 3 of the License, or
7e5b32f86a4c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79755
diff changeset
11 (at your option) any later version.
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 GNU Emacs is distributed in the hope that it will be useful,
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 GNU General Public License for more details.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
94714
7e5b32f86a4c Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79755
diff changeset
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20
78499
49b363c28dce Replace `iff' in comments.
Glenn Morris <rgm@gnu.org>
parents: 78258
diff changeset
21 /* Define WORDS_BIG_ENDIAN if lowest-numbered byte in a word
9095
23f72b18b420 (WORDS_BIG_ENDIAN): define or undef appropriately, superseding BIG_ENDIAN.
Karl Heuer <kwzh@gnu.org>
parents: 8892
diff changeset
22 is the most significant byte. */
23f72b18b420 (WORDS_BIG_ENDIAN): define or undef appropriately, superseding BIG_ENDIAN.
Karl Heuer <kwzh@gnu.org>
parents: 8892
diff changeset
23 #define WORDS_BIG_ENDIAN
23f72b18b420 (WORDS_BIG_ENDIAN): define or undef appropriately, superseding BIG_ENDIAN.
Karl Heuer <kwzh@gnu.org>
parents: 8892
diff changeset
24
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
25 /* Now define a symbol for the cpu type, if your compiler
96581
e1043d6b0d2b * m/template.h:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 94714
diff changeset
26 does not define it automatically.
e1043d6b0d2b * m/template.h:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 94714
diff changeset
27 Ones defined so far include m68k and many others */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 /* Define EXPLICIT_SIGN_EXTEND if XINT must explicitly sign-extend
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
30 the 24-bit bit field into an int. In other words, if bit fields
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31 are always unsigned.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
32
96602
0e3e875ffade * lisp.h:
Dan Nicolaescu <dann@ics.uci.edu>
parents: 96581
diff changeset
33 This flag only matters if you use USE_LISP_UNION_TYPE. */
456
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
34 #define EXPLICIT_SIGN_EXTEND
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
35
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36 /* Data type of load average, as read out of kmem. */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 #define LOAD_AVE_TYPE long
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39 /* Convert that into an integer that is 100 for a load average of 1.0 */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 #define LOAD_AVE_CVT(x) (int) (((double) (x)) * 100.0 / FSCALE)
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
42 /* Define CANNOT_DUMP on machines where unexec does not work.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43 Then the function dump-emacs will not be defined
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
44 and temacs will do (load "loadup") automatically unless told otherwise. */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
45 #define CANNOT_DUMP
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
46
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
47 /* Define VIRT_ADDR_VARIES if the virtual addresses of
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
48 pure and impure space as loaded can vary, and even their
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49 relative order cannot be relied on.
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
50
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51 Otherwise Emacs assumes that text space precedes data space,
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
52 numerically. */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
53 #define VIRT_ADDR_VARIES
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
54
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
55 /* Define NO_REMAP if memory segmentation makes it not work well
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
56 to change the boundary between the text section and data section
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
57 when Emacs is dumped. If you define this, the preloaded Lisp
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
58 code will not be sharable; but that's better than failing completely. */
c0335c02f1d7 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
59 #define NO_REMAP
553
e16b0df74717 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
60
e16b0df74717 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
61 /* Some really obscure 4.2-based systems (like Sequent DYNIX)
108506
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
62 do not support asynchronous I/O (using SIGIO) on sockets,
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
63 even though it works fine on tty's. If you have one of
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
64 these systems, define the following, and then use it in
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
65 config.h (or elsewhere) to decide when (not) to use SIGIO.
553
e16b0df74717 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
66
108506
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
67 You'd think this would go in an operating-system description file,
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
68 but since it only occurs on some, but not all, BSD systems, the
6fcaca6266ae Minor comment reformatting for some src/m/*.h files.
Glenn Morris <rgm@gnu.org>
parents: 108114
diff changeset
69 reasonable place to select for it is in the machine description file. */
553
e16b0df74717 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 456
diff changeset
70 #define NO_SOCK_SIGIO
2114
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 750
diff changeset
71
108639
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108506
diff changeset
72 /* After adding support for a new machine, modify the large case
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108506
diff changeset
73 statement in configure.in to recognize reasonable
2114
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 750
diff changeset
74 configuration names, and add a description of the system to
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 750
diff changeset
75 `etc/MACHINES'.
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 750
diff changeset
76
108639
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108506
diff changeset
77 Check for any tests of $machine in configure.in, and add an entry
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108506
diff changeset
78 for the new machine if needed.
cfaca963d899 * src/[ms]/template.h: Comments.
Glenn Morris <rgm@gnu.org>
parents: 108506
diff changeset
79
2114
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 750
diff changeset
80 If you've just fixed a problem in an existing configuration file,
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 750
diff changeset
81 you should also check `etc/MACHINES' to make sure its descriptions
d14a85e43f27 * m/template.h, s/template.h: Mention that `etc/MACHINES' and
Jim Blandy <jimb@redhat.com>
parents: 750
diff changeset
82 of known problems in that configuration should be updated. */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
83
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
84 /* arch-tag: d7dae0a9-4f99-4939-bef9-5738e1f33955
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 49600
diff changeset
85 (do not change this comment) */