annotate nt/INSTALL @ 42275:4bb44400f978

(Fdocumentation): Remove mocklisp case.
author Pavel Janík <Pavel@Janik.cz>
date Sat, 22 Dec 2001 13:59:08 +0000
parents f45165ce5cbc
children a8392117d6de
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
1 Building and Installing Emacs
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
2 on Windows NT/2000 and Windows 95/98/ME
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
3
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
4 Copyright (c) 2001 Free Software Foundation, Inc.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
5 See the end of the file for copying permissions.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
6
39152
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
7 If you used WinZip to unpack the distribution, we suggest to
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
8 remove the files and unpack again with a different program!
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
9 WinZip is known to create some subtle and hard to debug problems,
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
10 such as converting files to DOS CR-LF format, not creating empty
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
11 directories, etc. We suggest to use djtarnt.exe from the GNU FTP
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
12 site.
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
13
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
14 To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
37885
0cd37e185384 Clarify that building with MSVC requires nmake.
Jason Rumney <jasonr@gnu.org>
parents: 37710
diff changeset
15 later and nmake, or a Windows port of GCC 2.95 or later with Mingw
0cd37e185384 Clarify that building with MSVC requires nmake.
Jason Rumney <jasonr@gnu.org>
parents: 37710
diff changeset
16 and W32 API support and a port of GNU make. You can use the Cygwin
0cd37e185384 Clarify that building with MSVC requires nmake.
Jason Rumney <jasonr@gnu.org>
parents: 37710
diff changeset
17 ports of GCC, but Emacs requires the Mingw headers and libraries to
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
18 build (latest versions of the Cygwin toolkit, at least since v1.3.3,
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
19 include the MinGW headers and libraries as an integral part).
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
20
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
21 If you build Emacs on Windows 9X or ME, not on Windows 2000 or
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
22 Windows NT, we suggest to install the Cygwin port of Bash.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
23
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
24 Please see http://www.mingw.org for pointers to GCC/Mingw binaries.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
25
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
26 For reference, here is a list of which builds of GNU make are known
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
27 to work or not, and whether they work in the presence and/or absence
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
28 of sh.exe, the Cygwin port of Bash. Note that any version of make
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
29 that is compiled with Cygwin will only work with Cygwin tools, due to
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
30 the use of cygwin style paths. This means Cygwin make is unsuitable
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
31 for building parts of Emacs that need to invoke Emacs itself (leim and
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
32 "make bootstrap", for example). Also see the Trouble-shooting section
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
33 below if you decide to go ahead and use Cygwin make.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
34
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
35 sh exists no sh
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
36
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
37 cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5]
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
38 MSVC compiled gmake 3.77: okay okay
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
39 MSVC compiled gmake 3.78.1: okay okay
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
40 MSVC compiled gmake 3.79.1: okay okay
35814
70ef76f45876 Move note [4] to the no-sh column.
Eli Zaretskii <eliz@gnu.org>
parents: 35726
diff changeset
41 mingw32/gcc-2.92.2 make (3.77): okay okay[4]
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
42 cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5]
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
43 cygwin compiled make 3.78.1: fails[5] fails[2, 5]
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
44 cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5]
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
45 mingw32 compiled make 3.79.1: okay okay
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
46
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
47 Notes:
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
48
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
49 [1] doesn't cope with makefiles with DOS line endings, so must mount
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
50 emacs source with text!=binary.
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
51 [2] fails when needs to invoke shell commands; okay invoking gcc etc.
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
52 [3] requires LC_MESSAGES support to build; cannot build with early
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
53 versions of cygwin.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
54 [4] may fail on Windows 9X and Windows ME; if so, install Bash.
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
55 [5] fails when building leim due to the use of cygwin style paths.
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
56 May work if building emacs without leim.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
57
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
58 * Configuring
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
59
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
60 Configuration of Emacs is now handled by running configure.bat in the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
61 nt subdirectory. It will detect which compiler you have available,
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
62 and generate makefiles accordingly. You can override the compiler
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
63 detection, and control optimization and debug settings, by specifying
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
64 options on the command line when invoking configure.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
65
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
66 To configure Emacs to build with GCC or MSVC, whichever is available,
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
67 simply change to the nt subdirectory and run `configure' with no
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
68 options. To see what options are available, run `configure --help'.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
69
31625
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
70 N.B. It is normal to see a few error messages output while configure
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
71 is running, when gcc support is being tested. These cannot be
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
72 surpressed because of limitations in the Windows 9x command.com shell.
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
73
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
74 * Building
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
75
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
76 After running configure, simply run the appropriate `make' program for
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
77 your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
78 GNU make.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
79
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
80 As the files are compiled, you will see some warning messages
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
81 declaring that some functions don't return a value, or that some data
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
82 conversions will be lossy, etc. You can safely ignore these messages.
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
83 The warnings may be fixed in the main FSF source at some point, but
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
84 until then we will just live with them.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
85
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
86 * Installing
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
87
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
88 To install Emacs after it has compiled, simply run `nmake install'
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
89 or `make install', depending on which version of the Make utility
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
90 do you have.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
91
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
92 By default, Emacs will be installed in the location where it was
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
93 built, but a different location can be specified either using the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
94 --prefix option to configure, or by setting INSTALL_DIR when running
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
95 make, like so:
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
96
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
97 make install INSTALL_DIR=D:/emacs
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
98
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
99 (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
100
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
101 The install process will run addpm to setup the registry entries, and
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
102 to create a Start menu icon for Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
103
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
104 * Trouble-shooting
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
105
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
106 The main problems that are likely to be encountered when building
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
107 Emacs stem from using an old version of GCC, or old Mingw or W32 API
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
108 headers. Additionally, cygwin ports of GNU make may require the Emacs
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
109 source tree to be mounted with text!=binary, because the makefiles
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
110 generated by configure.bat necessarily use DOS line endings. Also,
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
111 cygwin ports of make must run in UNIX mode, either by specifying
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
112 --unix on the command line, or MAKE_MODE=UNIX in the environment.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
113
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
114 When configure runs, it attempts to detect when GCC itself, or the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
115 headers it is using, are not suitable for building Emacs. GCC version
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
116 2.95 or later is needed, because that is when the Windows port gained
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
117 sufficient support for anonymous structs and unions to cope with some
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
118 definitions from winnt.h that are used by addsection.c. The W32 API
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
119 headers that come with Cygwin b20.1 are incomplete, and do not include
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
120 some definitions required by addsection.c, for instance. Also, older
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
121 releases of the W32 API headers from Anders Norlander contain a typo
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
122 in the definition of IMAGE_FIRST_SECTION in winnt.h, which
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
123 addsection.c relies on. Versions of w32api-xxx.zip from at least
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
124 1999-11-18 onwards are okay.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
125
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
126 If configure succeeds, but make fails, install the Cygwin port of
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
127 Bash, even if the table above indicates that Emacs should be able to
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
128 build without sh.exe. (Some versions of Windows shells are too dumb
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
129 for Makefile's used by Emacs.)
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
130
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
131 If you are using certain Cygwin builds of GCC, such as Cygwin version
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
132 1.1.8, you may need to specify some extra compiler flags like so:
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
133
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
134 configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
36576
9f0620f192bd Add --ldflags to configure line for building with
Andrew Innes <andrewi@gnu.org>
parents: 35870
diff changeset
135 --ldflags -mwin32
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
136
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
137 However, the latest Cygwin versions, such as 1.3.3, don't need those
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
138 switches; you can simply use "configure --with-gcc".
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
139
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
140 We will attempt to auto-detect the need for these flags in a future
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
141 release.
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
142
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
143 * Debugging
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
144
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
145 You should be able to debug Emacs using the debugger that is
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
146 appropriate for the compiler you used, namely DevStudio or Windbg if
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
147 compiled with MSVC, or gdb if compiled with gcc.
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
148
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
149 Emacs functions implemented in C use a naming convention that reflects
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
150 their names in lisp. The names of the C routines are the lisp names
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
151 prefixed with 'F', and with dashes converted to underscores. For
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
152 example, the function call-process is implemented in C by
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
153 Fcall_process. Similarly, lisp variables are prefixed with 'V', again
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
154 with dashes converted to underscores. These conventions enable you to
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
155 easily set breakpoints or examine familiar lisp variables by name.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
156
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
157 Since Emacs data is often in the form of a lisp object, and the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
158 Lisp_Object type is difficult to examine manually in the MSVC
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
159 debugger, Emacs provides a helper routine called debug_print that
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
160 prints out a readable representation of a Lisp_Object. (If you are
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
161 using gdb, there is a .gdbinit file in the src directory which
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
162 provides definitions that are useful for examining lisp objects. The
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
163 following tips are mainly of interest when using MSVC.) The output
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
164 from debug_print is sent to stderr, and to the debugger via the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
165 OutputDebugString routine. The output sent to stderr should be
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
166 displayed in the console window that was opened when the emacs.exe
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
167 executable was started. The output sent to the debugger should be
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
168 displayed in its "Debug" output window.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
169
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
170 When you are in the process of debugging Emacs and you would like to
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
171 examine the contents of a Lisp_Object variable, popup the QuickWatch
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
172 window (QuickWatch has an eyeglass symbol on its button in the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
173 toolbar). In the text field at the top of the window, enter
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
174 debug_print(<variable>) and hit return. For example, start and run
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
175 Emacs in the debugger until it is waiting for user input. Then click
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
176 on the Break button in the debugger to halt execution. Emacs should
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
177 halt in ZwUserGetMessage waiting for an input event. Use the Call
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
178 Stack window to select the procedure w32_msp_pump up the call stack
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
179 (see below for why you have to do this). Open the QuickWatch window
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
180 and enter debug_print(Vexec_path). Evaluating this expression will
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
181 then print out the contents of the lisp variable exec-path.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
182
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
183 If QuickWatch reports that the symbol is unknown, then check the call
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
184 stack in the Call Stack window. If the selected frame in the call
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
185 stack is not an Emacs procedure, then the debugger won't recognize
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
186 Emacs symbols. Instead, select a frame that is inside an Emacs
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
187 procedure and try using debug_print again.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
188
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
189 If QuickWatch invokes debug_print but nothing happens, then check the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
190 thread that is selected in the debugger. If the selected thread is
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
191 not the last thread to run (the "current" thread), then it cannot be
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
192 used to execute debug_print. Use the Debug menu to select the current
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
193 thread and try using debug_print again. Note that the debugger halts
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
194 execution (e.g., due to a breakpoint) in the context of the current
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
195 thread, so this should only be a problem if you've explicitly switched
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
196 threads.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
197
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
198 COPYING PERMISSIONS
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
199
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
200 Permission is granted to anyone to make or distribute verbatim copies
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
201 of this document as received, in any medium, provided that the
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
202 copyright notice and permission notice are preserved,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
203 and that the distributor grants the recipient permission
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
204 for further redistribution as permitted by this notice.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
205
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
206 Permission is granted to distribute modified versions
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
207 of this document, or of portions of it,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
208 under the above conditions, provided also that they
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
209 carry prominent notices stating who last changed them,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
210 and that any new or changed statements about the activities
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
211 of the Free Software Foundation are approved by the Foundation.