|
25856
|
1 Building and Installing Emacs
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
2 on Windows NT/2K/XP and Windows 95/98/ME
|
|
25856
|
3
|
|
69567
|
4 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006
|
|
|
5 Free Software Foundation, Inc.
|
|
37710
|
6 See the end of the file for copying permissions.
|
|
|
7
|
|
69567
|
8 * For the impatient
|
|
|
9
|
|
|
10 Here are the concise instructions for configuring and building the
|
|
|
11 native Win32 binary of Emacs on Windows, for those who want to skip
|
|
|
12 the complex explanations and ``just do it'':
|
|
|
13
|
|
|
14 1. Change to the `nt' directory (the directory of this file):
|
|
|
15
|
|
|
16 cd nt
|
|
|
17
|
|
|
18 2. Run configure.bat. From the COMMAND.COM/CMD.EXE command prompt:
|
|
|
19
|
|
|
20 configure
|
|
|
21
|
|
|
22 from a Unixy shell prompt:
|
|
|
23
|
|
|
24 cmd /c configure.bat
|
|
|
25 or
|
|
|
26 command.com /c configure.bat
|
|
|
27
|
|
|
28 3. Run the Make utility suitable for your environment. If you build
|
|
|
29 with the Microsoft's Visual C compiler:
|
|
|
30
|
|
|
31 nmake
|
|
|
32
|
|
|
33 For the development environments based on GNU GCC (MinGW, MSYS,
|
|
72141
|
34 Cygwin - but see notes about Cygwin make below), depending on how
|
|
|
35 Make is called, it could be:
|
|
69567
|
36
|
|
|
37 make
|
|
|
38 or
|
|
72141
|
39 mingw32-make
|
|
|
40 or
|
|
69567
|
41 gnumake
|
|
|
42 or
|
|
|
43 gmake
|
|
|
44
|
|
|
45 (If you are building from CVS, say "make bootstrap" or "nmake
|
|
72141
|
46 bootstrap" instead and avoid using Cygwin make.)
|
|
69567
|
47
|
|
71548
|
48 4. Generate the Info manuals (only if you are building out of CVS, and
|
|
|
49 if you have makeinfo.exe installed):
|
|
69567
|
50
|
|
|
51 make info
|
|
|
52
|
|
|
53 (change "make" to "nmake" if you use MSVC).
|
|
|
54
|
|
|
55 5. Install the produced binaries:
|
|
|
56
|
|
|
57 make install
|
|
|
58
|
|
|
59 That's it!
|
|
|
60
|
|
|
61 If these short instructions somehow fail, read the rest of this
|
|
|
62 file.
|
|
|
63
|
|
|
64 * Preliminaries
|
|
|
65
|
|
39152
|
66 If you used WinZip to unpack the distribution, we suggest to
|
|
|
67 remove the files and unpack again with a different program!
|
|
|
68 WinZip is known to create some subtle and hard to debug problems,
|
|
49600
|
69 such as converting files to DOS CR-LF format, not creating empty
|
|
39152
|
70 directories, etc. We suggest to use djtarnt.exe from the GNU FTP
|
|
|
71 site.
|
|
|
72
|
|
52416
|
73 If you are building out of CVS, then some files in this directory
|
|
|
74 (.bat files, nmake.defs and makefile.w32-in) may need the line-ends
|
|
|
75 fixing first. The easiest way to do this and avoid future conflicts
|
|
|
76 is to run the following command in this (emacs/nt) directory:
|
|
63308
|
77
|
|
52416
|
78 cvs update -kb
|
|
63308
|
79
|
|
63571
|
80 Alternatively, use programs that convert end-of-line format, such as
|
|
|
81 dos2unix and unix2dos available from GnuWin32 or dtou and utod from
|
|
|
82 the DJGPP project.
|
|
63308
|
83
|
57565
5bab1954e91f
Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
84 In addition to this file, you should also read INSTALL.CVS in the
|
|
63308
|
85 parent directory, and make sure that you have a version of
|
|
|
86 "touch.exe" in your path, and that it will create files that do not
|
|
|
87 yet exist.
|
|
52416
|
88
|
|
69567
|
89 * Supported development environments
|
|
|
90
|
|
31083
|
91 To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
92 later and nmake, or a Windows port of GCC 2.95 or later with MinGW
|
|
67016
|
93 and W32 API support and a port of GNU Make. You can use the Cygwin
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
94 ports of GCC, but Emacs requires the MinGW headers and libraries to
|
|
39462
|
95 build (latest versions of the Cygwin toolkit, at least since v1.3.3,
|
|
|
96 include the MinGW headers and libraries as an integral part).
|
|
31083
|
97
|
|
69567
|
98 The rest of this file assumes you have a working development
|
|
|
99 environment. If you just installed such an environment, try
|
|
|
100 building a trivial C "Hello world" program, and see if it works. If
|
|
|
101 it doesn't work, resolve that problem first!
|
|
|
102
|
|
67016
|
103 If you use the MinGW port of GCC and GNU Make to build Emacs, there
|
|
|
104 are some compatibility issues wrt Make and the shell that is run by
|
|
|
105 Make, either the standard COMMAND.COM/CMD.EXE supplied with Windows
|
|
73297
|
106 or sh.exe., a port of a Unixy shell. For reference, below is a list
|
|
67016
|
107 of which builds of GNU Make are known to work or not, and whether
|
|
|
108 they work in the presence and/or absence of sh.exe, the Cygwin port
|
|
|
109 of Bash. Note that any version of Make that is compiled with Cygwin
|
|
|
110 will only work with Cygwin tools, due to the use of cygwin style
|
|
|
111 paths. This means Cygwin Make is unsuitable for building parts of
|
|
|
112 Emacs that need to invoke Emacs itself (leim and "make bootstrap",
|
|
|
113 for example). Also see the Trouble-shooting section below if you
|
|
|
114 decide to go ahead and use Cygwin make.
|
|
|
115
|
|
|
116 In addition, using 4NT as your shell is known to fail the build process,
|
|
|
117 at least for 4NT version 3.01. Use CMD.EXE, the default Windows shell,
|
|
|
118 instead. MSYS sh.exe also appears to cause various problems. If you have
|
|
|
119 MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe
|
|
|
120 instead of sh.exe.
|
|
|
121
|
|
|
122 sh exists no sh
|
|
|
123
|
|
|
124 cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5]
|
|
|
125 MSVC compiled gmake 3.77: okay okay
|
|
|
126 MSVC compiled gmake 3.78.1: okay okay
|
|
|
127 MSVC compiled gmake 3.79.1: okay okay
|
|
|
128 mingw32/gcc-2.92.2 make (3.77): okay okay[4]
|
|
|
129 cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5]
|
|
|
130 cygwin compiled make 3.78.1: fails[5] fails[2, 5]
|
|
|
131 cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5]
|
|
73297
|
132 cygwin compiled make 3.80: fails?[6] fails?[6]
|
|
|
133 cygwin compiled make 3.81: fails fails?[6]
|
|
67016
|
134 mingw32 compiled make 3.79.1: okay okay
|
|
|
135 mingw32 compiled make 3.80: okay unknown[6]
|
71164
1f33ca9aff72
Add Make 3.81 to the list of Make & shell combinations known to work.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
136 mingw32 compiled make 3.81: okay okay[7]
|
|
67016
|
137
|
|
|
138 Notes:
|
|
|
139
|
|
|
140 [1] doesn't cope with makefiles with DOS line endings, so must mount
|
|
|
141 emacs source with text!=binary.
|
|
|
142 [2] fails when needs to invoke shell commands; okay invoking gcc etc.
|
|
|
143 [3] requires LC_MESSAGES support to build; cannot build with early
|
|
|
144 versions of cygwin.
|
|
|
145 [4] may fail on Windows 9X and Windows ME; if so, install Bash.
|
|
|
146 [5] fails when building leim due to the use of cygwin style paths.
|
|
|
147 May work if building emacs without leim.
|
|
|
148 [6] please report if you try this combination.
|
|
71594
|
149 [7] tested only on Windows XP.
|
|
67016
|
150
|
49871
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
151 Other compilers may work, but specific reports from people that have
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
152 tried suggest that the Intel C compiler (for example) may produce an
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
153 Emacs executable with strange filename completion behaviour. Unless
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
154 you would like to assist by finding and fixing the cause of any bugs
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
155 like this, we recommend the use of the supported compilers mentioned
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
156 in the previous paragraph.
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
157
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
158 You will also need a copy of the Posix cp, rm and mv programs. These
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
159 and other useful Posix utilities can be obtained from one of several
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
160 projects:
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
161
|
|
69567
|
162 * http://gnuwin32.sourceforge.net/ ( GnuWin32 )
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
163 * http://www.mingw.org/ ( MinGW )
|
|
62677
|
164 * http://www.cygwin.com/ ( Cygwin )
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
165 * http://unxutils.sourceforge.net/ ( UnxUtils )
|
57565
5bab1954e91f
Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
166
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
167 If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
|
|
69567
|
168 Windows NT, we suggest to install the Cygwin port of Bash. That is
|
|
|
169 because the native Windows shell COMMAND.COM is too limited; the
|
|
|
170 Emacs build procedure tries very hard to support even such limited
|
|
|
171 shells, but as none of the Windows developers of Emacs work on
|
|
|
172 Windows 9x, we cannot guarantee that it works without a more
|
|
|
173 powerful shell.
|
|
35726
|
174
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
175 Additional instructions and help for building Emacs on Windows can be
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
176 found at the Emacs Wiki:
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
177
|
|
69567
|
178 http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit
|
|
25856
|
179
|
|
63308
|
180 and at this URL:
|
|
|
181
|
|
69567
|
182 http://ourcomments.org/Emacs/w32-build-emacs.html
|
|
63308
|
183
|
|
35870
|
184 * Configuring
|
|
25856
|
185
|
|
31083
|
186 Configuration of Emacs is now handled by running configure.bat in the
|
|
69567
|
187 `nt' subdirectory. It will detect which compiler you have available,
|
|
31083
|
188 and generate makefiles accordingly. You can override the compiler
|
|
|
189 detection, and control optimization and debug settings, by specifying
|
|
|
190 options on the command line when invoking configure.
|
|
25856
|
191
|
|
31083
|
192 To configure Emacs to build with GCC or MSVC, whichever is available,
|
|
69567
|
193 simply change to the `nt' subdirectory and run `configure.bat' with no
|
|
31083
|
194 options. To see what options are available, run `configure --help'.
|
|
25856
|
195
|
|
31625
|
196 N.B. It is normal to see a few error messages output while configure
|
|
|
197 is running, when gcc support is being tested. These cannot be
|
|
|
198 surpressed because of limitations in the Windows 9x command.com shell.
|
|
|
199
|
|
63308
|
200 You are encouraged to look at the file config.log which shows details
|
|
|
201 for failed tests, after configure.bat finishes. Any unexplained failure
|
|
|
202 should be investigated and perhaps reported as a bug (see the section
|
|
|
203 about reporting bugs in the file README in this directory and in the
|
|
|
204 Emacs manual).
|
|
|
205
|
|
49451
|
206 * Optional image library support
|
|
|
207
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
208 In addition to its "native" image formats (pbm and xbm), Emacs can
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
209 handle other image types: xpm, tiff, gif, png and jpeg (postscript is
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
210 currently unsupported on Windows). To build Emacs with support for
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
211 them, the corresponding headers must be in the include path when the
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
212 configure script is run. This can be setup using environment
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
213 variables, or by specifying --cflags -I... options on the command-line
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
214 to configure.bat. The configure script will report whether it was
|
|
63308
|
215 able to detect the headers. If the results of this testing appear to be
|
|
|
216 incorrect, please look for details in the file config.log: it will show
|
|
|
217 the failed test programs and compiler error messages that should explain
|
|
|
218 what is wrong. (Usually, any such failures happen because some headers
|
|
|
219 are missing due to bad packaging of the image support libraries.)
|
|
49451
|
220
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
221 To use the external image support, the DLLs implementing the
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
222 functionality must be found when Emacs first needs them, either on the
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
223 PATH, or in the same directory as emacs.exe. Failure to find a
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
224 library is not an error; the associated image format will simply be
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
225 unavailable. Note that once Emacs has determined that a library can
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
226 not be found, there's no way to force it to try again, other than
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
227 restarting. See the variable `image-library-alist' to configure the
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
228 expected names of the libraries.
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
229
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
230 Some image libraries have dependencies on one another, or on zlib.
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
231 For example, tiff support depends on the jpeg library. If you did not
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
232 compile the libraries yourself, you must make sure that any dependency
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
233 is in the PATH or otherwise accesible and that the binaries are
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
234 compatible (for example, that they were built with the same compiler).
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
235
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
236 Binaries for the image libraries (among many others) can be found at
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
237 the GnuWin32 project. These are built with MinGW, but they can be
|
|
63308
|
238 used with both GCC/MinGW and MSVC builds of Emacs. See the info on
|
|
63319
|
239 http://ourcomments.org/Emacs/EmacsW32.html for more details about
|
|
63308
|
240 installing image support libraries.
|
|
49451
|
241
|
|
35870
|
242 * Building
|
|
25856
|
243
|
|
31083
|
244 After running configure, simply run the appropriate `make' program for
|
|
|
245 your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is
|
|
69567
|
246 GNU make. (If you are building out of CVS, say "make bootstrap" or
|
|
|
247 "nmake bootstrap" instead.)
|
|
25856
|
248
|
|
31083
|
249 As the files are compiled, you will see some warning messages
|
|
|
250 declaring that some functions don't return a value, or that some data
|
|
|
251 conversions will be lossy, etc. You can safely ignore these messages.
|
|
|
252 The warnings may be fixed in the main FSF source at some point, but
|
|
|
253 until then we will just live with them.
|
|
25856
|
254
|
|
69567
|
255 If you are building from CVS, the following commands will produce
|
|
|
256 the Info manuals (which are not part of the CVS repository):
|
|
|
257
|
|
|
258 make info
|
|
|
259 or
|
|
|
260 nmake info
|
|
|
261
|
|
71548
|
262 Note that you will need makeinfo.exe (from the GNU Texinfo package)
|
|
|
263 in order for this command to succeed.
|
|
|
264
|
|
35870
|
265 * Installing
|
|
25856
|
266
|
|
39144
|
267 To install Emacs after it has compiled, simply run `nmake install'
|
|
|
268 or `make install', depending on which version of the Make utility
|
|
|
269 do you have.
|
|
25856
|
270
|
|
31083
|
271 By default, Emacs will be installed in the location where it was
|
|
|
272 built, but a different location can be specified either using the
|
|
|
273 --prefix option to configure, or by setting INSTALL_DIR when running
|
|
|
274 make, like so:
|
|
25856
|
275
|
|
31083
|
276 make install INSTALL_DIR=D:/emacs
|
|
25856
|
277
|
|
39144
|
278 (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).
|
|
|
279
|
|
31083
|
280 The install process will run addpm to setup the registry entries, and
|
|
|
281 to create a Start menu icon for Emacs.
|
|
25856
|
282
|
|
35870
|
283 * Trouble-shooting
|
|
25856
|
284
|
|
31083
|
285 The main problems that are likely to be encountered when building
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
286 Emacs stem from using an old version of GCC, or old MinGW or W32 API
|
|
31083
|
287 headers. Additionally, cygwin ports of GNU make may require the Emacs
|
|
|
288 source tree to be mounted with text!=binary, because the makefiles
|
|
|
289 generated by configure.bat necessarily use DOS line endings. Also,
|
|
|
290 cygwin ports of make must run in UNIX mode, either by specifying
|
|
|
291 --unix on the command line, or MAKE_MODE=UNIX in the environment.
|
|
25856
|
292
|
|
31083
|
293 When configure runs, it attempts to detect when GCC itself, or the
|
|
|
294 headers it is using, are not suitable for building Emacs. GCC version
|
|
|
295 2.95 or later is needed, because that is when the Windows port gained
|
|
|
296 sufficient support for anonymous structs and unions to cope with some
|
|
|
297 definitions from winnt.h that are used by addsection.c. The W32 API
|
|
|
298 headers that come with Cygwin b20.1 are incomplete, and do not include
|
|
|
299 some definitions required by addsection.c, for instance. Also, older
|
|
|
300 releases of the W32 API headers from Anders Norlander contain a typo
|
|
|
301 in the definition of IMAGE_FIRST_SECTION in winnt.h, which
|
|
|
302 addsection.c relies on. Versions of w32api-xxx.zip from at least
|
|
|
303 1999-11-18 onwards are okay.
|
|
25856
|
304
|
|
63308
|
305 When in doubt about correctness of what configure did, look at the file
|
|
|
306 config.log, which shows all the failed test programs and compiler
|
|
|
307 messages associated with the failures. If that doesn't give a clue,
|
|
|
308 please report the problems, together with the relevant fragments from
|
|
|
309 config.log, as bugs.
|
|
|
310
|
|
35726
|
311 If configure succeeds, but make fails, install the Cygwin port of
|
|
|
312 Bash, even if the table above indicates that Emacs should be able to
|
|
|
313 build without sh.exe. (Some versions of Windows shells are too dumb
|
|
|
314 for Makefile's used by Emacs.)
|
|
|
315
|
|
39462
|
316 If you are using certain Cygwin builds of GCC, such as Cygwin version
|
|
35870
|
317 1.1.8, you may need to specify some extra compiler flags like so:
|
|
|
318
|
|
|
319 configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
|
|
36576
|
320 --ldflags -mwin32
|
|
35870
|
321
|
|
39462
|
322 However, the latest Cygwin versions, such as 1.3.3, don't need those
|
|
|
323 switches; you can simply use "configure --with-gcc".
|
|
|
324
|
|
35870
|
325 We will attempt to auto-detect the need for these flags in a future
|
|
|
326 release.
|
|
|
327
|
|
|
328 * Debugging
|
|
25856
|
329
|
|
31083
|
330 You should be able to debug Emacs using the debugger that is
|
|
|
331 appropriate for the compiler you used, namely DevStudio or Windbg if
|
67437
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
332 compiled with MSVC, or GDB if compiled with GCC.
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
333
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
334 When Emacs aborts due to a fatal internal error, Emacs on Windows
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
335 pops up an Emacs Abort Dialog asking you whether you want to debug
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
336 Emacs or terminate it. If Emacs was built with MSVC, click YES
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
337 twice, and Windbg or the DevStudio debugger will start up
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
338 automatically. If Emacs was built with GCC, first start GDB and
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
339 attach it to the Emacs process with the "gdb -p EMACS-PID" command,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
340 where EMACS-PID is the Emacs process ID (which you can see in the
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
341 Windows Task Manager), type the "continue" command inside GDB, and
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
342 only then click YES on the abort dialog. This will pass control to
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
343 the debugger, and you will be able to debug the cause of the fatal
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
344 error.
|
|
31083
|
345
|
|
|
346 Emacs functions implemented in C use a naming convention that reflects
|
|
|
347 their names in lisp. The names of the C routines are the lisp names
|
|
|
348 prefixed with 'F', and with dashes converted to underscores. For
|
|
|
349 example, the function call-process is implemented in C by
|
|
|
350 Fcall_process. Similarly, lisp variables are prefixed with 'V', again
|
|
|
351 with dashes converted to underscores. These conventions enable you to
|
|
|
352 easily set breakpoints or examine familiar lisp variables by name.
|
|
25856
|
353
|
|
31083
|
354 Since Emacs data is often in the form of a lisp object, and the
|
67437
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
355 Lisp_Object type is difficult to examine manually in a debugger,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
356 Emacs provides a helper routine called debug_print that prints out a
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
357 readable representation of a Lisp_Object. If you are using GDB,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
358 there is a .gdbinit file in the src directory which provides
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
359 definitions that are useful for examining lisp objects. Therefore,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
360 the following tips are mainly of interest when using MSVC.
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
361
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
362 The output from debug_print is sent to stderr, and to the debugger
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
363 via the OutputDebugString routine. The output sent to stderr should
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
364 be displayed in the console window that was opened when the
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
365 emacs.exe executable was started. The output sent to the debugger
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
366 should be displayed in its "Debug" output window.
|
|
25856
|
367
|
|
31083
|
368 When you are in the process of debugging Emacs and you would like to
|
|
|
369 examine the contents of a Lisp_Object variable, popup the QuickWatch
|
|
|
370 window (QuickWatch has an eyeglass symbol on its button in the
|
|
|
371 toolbar). In the text field at the top of the window, enter
|
|
|
372 debug_print(<variable>) and hit return. For example, start and run
|
|
|
373 Emacs in the debugger until it is waiting for user input. Then click
|
|
|
374 on the Break button in the debugger to halt execution. Emacs should
|
|
|
375 halt in ZwUserGetMessage waiting for an input event. Use the Call
|
|
|
376 Stack window to select the procedure w32_msp_pump up the call stack
|
|
|
377 (see below for why you have to do this). Open the QuickWatch window
|
|
|
378 and enter debug_print(Vexec_path). Evaluating this expression will
|
|
|
379 then print out the contents of the lisp variable exec-path.
|
|
25856
|
380
|
|
31083
|
381 If QuickWatch reports that the symbol is unknown, then check the call
|
|
|
382 stack in the Call Stack window. If the selected frame in the call
|
|
|
383 stack is not an Emacs procedure, then the debugger won't recognize
|
|
|
384 Emacs symbols. Instead, select a frame that is inside an Emacs
|
|
|
385 procedure and try using debug_print again.
|
|
25856
|
386
|
|
31083
|
387 If QuickWatch invokes debug_print but nothing happens, then check the
|
|
|
388 thread that is selected in the debugger. If the selected thread is
|
|
|
389 not the last thread to run (the "current" thread), then it cannot be
|
|
|
390 used to execute debug_print. Use the Debug menu to select the current
|
|
|
391 thread and try using debug_print again. Note that the debugger halts
|
|
|
392 execution (e.g., due to a breakpoint) in the context of the current
|
|
|
393 thread, so this should only be a problem if you've explicitly switched
|
|
|
394 threads.
|
|
37710
|
395
|
|
|
396 COPYING PERMISSIONS
|
|
|
397
|
|
|
398 Permission is granted to anyone to make or distribute verbatim copies
|
|
|
399 of this document as received, in any medium, provided that the
|
|
|
400 copyright notice and permission notice are preserved,
|
|
|
401 and that the distributor grants the recipient permission
|
|
|
402 for further redistribution as permitted by this notice.
|
|
|
403
|
|
|
404 Permission is granted to distribute modified versions
|
|
|
405 of this document, or of portions of it,
|
|
|
406 under the above conditions, provided also that they
|
|
|
407 carry prominent notices stating who last changed them,
|
|
|
408 and that any new or changed statements about the activities
|
|
|
409 of the Free Software Foundation are approved by the Foundation.
|
