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
|
64890
|
4 Copyright (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
|
37710
|
5 See the end of the file for copying permissions.
|
|
6
|
39152
|
7 If you used WinZip to unpack the distribution, we suggest to
|
|
8 remove the files and unpack again with a different program!
|
|
9 WinZip is known to create some subtle and hard to debug problems,
|
49600
|
10 such as converting files to DOS CR-LF format, not creating empty
|
39152
|
11 directories, etc. We suggest to use djtarnt.exe from the GNU FTP
|
|
12 site.
|
|
13
|
52416
|
14 If you are building out of CVS, then some files in this directory
|
|
15 (.bat files, nmake.defs and makefile.w32-in) may need the line-ends
|
|
16 fixing first. The easiest way to do this and avoid future conflicts
|
|
17 is to run the following command in this (emacs/nt) directory:
|
63308
|
18
|
52416
|
19 cvs update -kb
|
63308
|
20
|
63571
|
21 Alternatively, use programs that convert end-of-line format, such as
|
|
22 dos2unix and unix2dos available from GnuWin32 or dtou and utod from
|
|
23 the DJGPP project.
|
63308
|
24
|
57565
5bab1954e91f
Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
25 In addition to this file, you should also read INSTALL.CVS in the
|
63308
|
26 parent directory, and make sure that you have a version of
|
|
27 "touch.exe" in your path, and that it will create files that do not
|
|
28 yet exist.
|
52416
|
29
|
31083
|
30 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
|
31 later and nmake, or a Windows port of GCC 2.95 or later with MinGW
|
67016
|
32 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
|
33 ports of GCC, but Emacs requires the MinGW headers and libraries to
|
39462
|
34 build (latest versions of the Cygwin toolkit, at least since v1.3.3,
|
|
35 include the MinGW headers and libraries as an integral part).
|
31083
|
36
|
67016
|
37 If you use the MinGW port of GCC and GNU Make to build Emacs, there
|
|
38 are some compatibility issues wrt Make and the shell that is run by
|
|
39 Make, either the standard COMMAND.COM/CMD.EXE supplied with Windows
|
|
40 or sh.exe., a port of a Unixy shell. For reference, here is a list
|
|
41 of which builds of GNU Make are known to work or not, and whether
|
|
42 they work in the presence and/or absence of sh.exe, the Cygwin port
|
|
43 of Bash. Note that any version of Make that is compiled with Cygwin
|
|
44 will only work with Cygwin tools, due to the use of cygwin style
|
|
45 paths. This means Cygwin Make is unsuitable for building parts of
|
|
46 Emacs that need to invoke Emacs itself (leim and "make bootstrap",
|
|
47 for example). Also see the Trouble-shooting section below if you
|
|
48 decide to go ahead and use Cygwin make.
|
|
49
|
|
50 In addition, using 4NT as your shell is known to fail the build process,
|
|
51 at least for 4NT version 3.01. Use CMD.EXE, the default Windows shell,
|
|
52 instead. MSYS sh.exe also appears to cause various problems. If you have
|
|
53 MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe
|
|
54 instead of sh.exe.
|
|
55
|
|
56 sh exists no sh
|
|
57
|
|
58 cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5]
|
|
59 MSVC compiled gmake 3.77: okay okay
|
|
60 MSVC compiled gmake 3.78.1: okay okay
|
|
61 MSVC compiled gmake 3.79.1: okay okay
|
|
62 mingw32/gcc-2.92.2 make (3.77): okay okay[4]
|
|
63 cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5]
|
|
64 cygwin compiled make 3.78.1: fails[5] fails[2, 5]
|
|
65 cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5]
|
|
66 mingw32 compiled make 3.79.1: okay okay
|
|
67 mingw32 compiled make 3.80: okay unknown[6]
|
|
68
|
|
69 Notes:
|
|
70
|
|
71 [1] doesn't cope with makefiles with DOS line endings, so must mount
|
|
72 emacs source with text!=binary.
|
|
73 [2] fails when needs to invoke shell commands; okay invoking gcc etc.
|
|
74 [3] requires LC_MESSAGES support to build; cannot build with early
|
|
75 versions of cygwin.
|
|
76 [4] may fail on Windows 9X and Windows ME; if so, install Bash.
|
|
77 [5] fails when building leim due to the use of cygwin style paths.
|
|
78 May work if building emacs without leim.
|
|
79 [6] please report if you try this combination.
|
|
80
|
49871
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
81 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
|
82 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
|
83 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
|
84 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
|
85 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
|
86 in the previous paragraph.
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
87
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
88 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
|
89 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
|
90 projects:
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
91
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
92 * http://www.mingw.org/ ( MinGW )
|
62677
|
93 * 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
|
94 * http://unxutils.sourceforge.net/ ( UnxUtils )
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
95 * http://gnuwin32.sourceforge.net/ ( GnuWin32 )
|
57565
5bab1954e91f
Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
96
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
97 If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
|
35870
|
98 Windows NT, we suggest to install the Cygwin port of Bash.
|
35726
|
99
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
100 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
|
101 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
|
102
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
103 http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit
|
25856
|
104
|
63308
|
105 and at this URL:
|
|
106
|
63571
|
107 http://ourcomments.org/Emacs/w32-build-emacs.html
|
63308
|
108
|
35870
|
109 * Configuring
|
25856
|
110
|
31083
|
111 Configuration of Emacs is now handled by running configure.bat in the
|
|
112 nt subdirectory. It will detect which compiler you have available,
|
|
113 and generate makefiles accordingly. You can override the compiler
|
|
114 detection, and control optimization and debug settings, by specifying
|
|
115 options on the command line when invoking configure.
|
25856
|
116
|
31083
|
117 To configure Emacs to build with GCC or MSVC, whichever is available,
|
|
118 simply change to the nt subdirectory and run `configure' with no
|
|
119 options. To see what options are available, run `configure --help'.
|
25856
|
120
|
31625
|
121 N.B. It is normal to see a few error messages output while configure
|
|
122 is running, when gcc support is being tested. These cannot be
|
|
123 surpressed because of limitations in the Windows 9x command.com shell.
|
|
124
|
63308
|
125 You are encouraged to look at the file config.log which shows details
|
|
126 for failed tests, after configure.bat finishes. Any unexplained failure
|
|
127 should be investigated and perhaps reported as a bug (see the section
|
|
128 about reporting bugs in the file README in this directory and in the
|
|
129 Emacs manual).
|
|
130
|
49451
|
131 * Optional image library support
|
|
132
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
133 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
|
134 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
|
135 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
|
136 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
|
137 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
|
138 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
|
139 to configure.bat. The configure script will report whether it was
|
63308
|
140 able to detect the headers. If the results of this testing appear to be
|
|
141 incorrect, please look for details in the file config.log: it will show
|
|
142 the failed test programs and compiler error messages that should explain
|
|
143 what is wrong. (Usually, any such failures happen because some headers
|
|
144 are missing due to bad packaging of the image support libraries.)
|
49451
|
145
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
146 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
|
147 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
|
148 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
|
149 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
|
150 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
|
151 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
|
152 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
|
153 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
|
154
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
155 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
|
156 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
|
157 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
|
158 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
|
159 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
|
160
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
161 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
|
162 the GnuWin32 project. These are built with MinGW, but they can be
|
63308
|
163 used with both GCC/MinGW and MSVC builds of Emacs. See the info on
|
63319
|
164 http://ourcomments.org/Emacs/EmacsW32.html for more details about
|
63308
|
165 installing image support libraries.
|
49451
|
166
|
35870
|
167 * Building
|
25856
|
168
|
31083
|
169 After running configure, simply run the appropriate `make' program for
|
|
170 your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is
|
|
171 GNU make.
|
25856
|
172
|
31083
|
173 As the files are compiled, you will see some warning messages
|
|
174 declaring that some functions don't return a value, or that some data
|
|
175 conversions will be lossy, etc. You can safely ignore these messages.
|
|
176 The warnings may be fixed in the main FSF source at some point, but
|
|
177 until then we will just live with them.
|
25856
|
178
|
35870
|
179 * Installing
|
25856
|
180
|
39144
|
181 To install Emacs after it has compiled, simply run `nmake install'
|
|
182 or `make install', depending on which version of the Make utility
|
|
183 do you have.
|
25856
|
184
|
31083
|
185 By default, Emacs will be installed in the location where it was
|
|
186 built, but a different location can be specified either using the
|
|
187 --prefix option to configure, or by setting INSTALL_DIR when running
|
|
188 make, like so:
|
25856
|
189
|
31083
|
190 make install INSTALL_DIR=D:/emacs
|
25856
|
191
|
39144
|
192 (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).
|
|
193
|
31083
|
194 The install process will run addpm to setup the registry entries, and
|
|
195 to create a Start menu icon for Emacs.
|
25856
|
196
|
35870
|
197 * Trouble-shooting
|
25856
|
198
|
31083
|
199 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
|
200 Emacs stem from using an old version of GCC, or old MinGW or W32 API
|
31083
|
201 headers. Additionally, cygwin ports of GNU make may require the Emacs
|
|
202 source tree to be mounted with text!=binary, because the makefiles
|
|
203 generated by configure.bat necessarily use DOS line endings. Also,
|
|
204 cygwin ports of make must run in UNIX mode, either by specifying
|
|
205 --unix on the command line, or MAKE_MODE=UNIX in the environment.
|
25856
|
206
|
31083
|
207 When configure runs, it attempts to detect when GCC itself, or the
|
|
208 headers it is using, are not suitable for building Emacs. GCC version
|
|
209 2.95 or later is needed, because that is when the Windows port gained
|
|
210 sufficient support for anonymous structs and unions to cope with some
|
|
211 definitions from winnt.h that are used by addsection.c. The W32 API
|
|
212 headers that come with Cygwin b20.1 are incomplete, and do not include
|
|
213 some definitions required by addsection.c, for instance. Also, older
|
|
214 releases of the W32 API headers from Anders Norlander contain a typo
|
|
215 in the definition of IMAGE_FIRST_SECTION in winnt.h, which
|
|
216 addsection.c relies on. Versions of w32api-xxx.zip from at least
|
|
217 1999-11-18 onwards are okay.
|
25856
|
218
|
63308
|
219 When in doubt about correctness of what configure did, look at the file
|
|
220 config.log, which shows all the failed test programs and compiler
|
|
221 messages associated with the failures. If that doesn't give a clue,
|
|
222 please report the problems, together with the relevant fragments from
|
|
223 config.log, as bugs.
|
|
224
|
35726
|
225 If configure succeeds, but make fails, install the Cygwin port of
|
|
226 Bash, even if the table above indicates that Emacs should be able to
|
|
227 build without sh.exe. (Some versions of Windows shells are too dumb
|
|
228 for Makefile's used by Emacs.)
|
|
229
|
39462
|
230 If you are using certain Cygwin builds of GCC, such as Cygwin version
|
35870
|
231 1.1.8, you may need to specify some extra compiler flags like so:
|
|
232
|
|
233 configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
|
36576
|
234 --ldflags -mwin32
|
35870
|
235
|
39462
|
236 However, the latest Cygwin versions, such as 1.3.3, don't need those
|
|
237 switches; you can simply use "configure --with-gcc".
|
|
238
|
35870
|
239 We will attempt to auto-detect the need for these flags in a future
|
|
240 release.
|
|
241
|
|
242 * Debugging
|
25856
|
243
|
31083
|
244 You should be able to debug Emacs using the debugger that is
|
|
245 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
|
246 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
|
247
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
248 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
|
249 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
|
250 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
|
251 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
|
252 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
|
253 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
|
254 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
|
255 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
|
256 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
|
257 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
|
258 error.
|
31083
|
259
|
|
260 Emacs functions implemented in C use a naming convention that reflects
|
|
261 their names in lisp. The names of the C routines are the lisp names
|
|
262 prefixed with 'F', and with dashes converted to underscores. For
|
|
263 example, the function call-process is implemented in C by
|
|
264 Fcall_process. Similarly, lisp variables are prefixed with 'V', again
|
|
265 with dashes converted to underscores. These conventions enable you to
|
|
266 easily set breakpoints or examine familiar lisp variables by name.
|
25856
|
267
|
31083
|
268 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
|
269 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
|
270 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
|
271 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
|
272 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
|
273 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
|
274 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
|
275
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
276 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
|
277 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
|
278 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
|
279 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
|
280 should be displayed in its "Debug" output window.
|
25856
|
281
|
31083
|
282 When you are in the process of debugging Emacs and you would like to
|
|
283 examine the contents of a Lisp_Object variable, popup the QuickWatch
|
|
284 window (QuickWatch has an eyeglass symbol on its button in the
|
|
285 toolbar). In the text field at the top of the window, enter
|
|
286 debug_print(<variable>) and hit return. For example, start and run
|
|
287 Emacs in the debugger until it is waiting for user input. Then click
|
|
288 on the Break button in the debugger to halt execution. Emacs should
|
|
289 halt in ZwUserGetMessage waiting for an input event. Use the Call
|
|
290 Stack window to select the procedure w32_msp_pump up the call stack
|
|
291 (see below for why you have to do this). Open the QuickWatch window
|
|
292 and enter debug_print(Vexec_path). Evaluating this expression will
|
|
293 then print out the contents of the lisp variable exec-path.
|
25856
|
294
|
31083
|
295 If QuickWatch reports that the symbol is unknown, then check the call
|
|
296 stack in the Call Stack window. If the selected frame in the call
|
|
297 stack is not an Emacs procedure, then the debugger won't recognize
|
|
298 Emacs symbols. Instead, select a frame that is inside an Emacs
|
|
299 procedure and try using debug_print again.
|
25856
|
300
|
31083
|
301 If QuickWatch invokes debug_print but nothing happens, then check the
|
|
302 thread that is selected in the debugger. If the selected thread is
|
|
303 not the last thread to run (the "current" thread), then it cannot be
|
|
304 used to execute debug_print. Use the Debug menu to select the current
|
|
305 thread and try using debug_print again. Note that the debugger halts
|
|
306 execution (e.g., due to a breakpoint) in the context of the current
|
|
307 thread, so this should only be a problem if you've explicitly switched
|
|
308 threads.
|
37710
|
309
|
|
310 COPYING PERMISSIONS
|
|
311
|
|
312 Permission is granted to anyone to make or distribute verbatim copies
|
|
313 of this document as received, in any medium, provided that the
|
|
314 copyright notice and permission notice are preserved,
|
|
315 and that the distributor grants the recipient permission
|
|
316 for further redistribution as permitted by this notice.
|
|
317
|
|
318 Permission is granted to distribute modified versions
|
|
319 of this document, or of portions of it,
|
|
320 under the above conditions, provided also that they
|
|
321 carry prominent notices stating who last changed them,
|
|
322 and that any new or changed statements about the activities
|
|
323 of the Free Software Foundation are approved by the Foundation.
|