annotate nt/INSTALL @ 74937:e89aaee63398

Update table of supported Make ports. Show "make -j" command that is known to work.
author Eli Zaretskii <eliz@gnu.org>
date Wed, 27 Dec 2006 13:54:18 +0000
parents e50355d072ce
children 3d45362f1d38 bc10a33dd40b
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
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
2 on Windows NT/2K/XP and Windows 95/98/ME
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
3
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
4 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
5 Free Software Foundation, Inc.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
6 See the end of the file for copying permissions.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
7
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
8 * For the impatient
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
9
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
10 Here are the concise instructions for configuring and building the
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
11 native Win32 binary of Emacs on Windows, for those who want to skip
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
12 the complex explanations and ``just do it'':
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
13
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
14 1. Change to the `nt' directory (the directory of this file):
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
15
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
16 cd nt
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
17
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
18 2. Run configure.bat. From the COMMAND.COM/CMD.EXE command prompt:
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
19
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
20 configure
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
21
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
22 from a Unixy shell prompt:
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
23
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
24 cmd /c configure.bat
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
25 or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
26 command.com /c configure.bat
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
27
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
28 3. Run the Make utility suitable for your environment. If you build
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
29 with the Microsoft's Visual C compiler:
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
30
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
31 nmake
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
32
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
33 For the development environments based on GNU GCC (MinGW, MSYS,
72141
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
34 Cygwin - but see notes about Cygwin make below), depending on how
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
35 Make is called, it could be:
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
36
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
37 make
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
38 or
72141
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
39 mingw32-make
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
40 or
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
41 gnumake
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
42 or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
43 gmake
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
44
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
45 (If you are building from CVS, say "make bootstrap" or "nmake
74820
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
46 bootstrap" instead, and avoid using Cygwin make.)
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
47
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
48 With GNU Make, you can use the -j command-line option to have
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
49 Make execute several commands at once, like this:
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
50
74937
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
51 gmake -j 2 XMFLAGS="-j 2"
74820
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
52
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
53 The XMFLAGS variable overrides the default behavior of GNU Make
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
54 on Windows, whereby recursive Make invocations reset the maximum
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
55 number of simultaneous commands to 1. The above command allows
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
56 up to 4 simultaneous commands at once in the top-level Make, and
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
57 up to 3 in each one of the recursive Make's.
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
58
71548
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
59 4. Generate the Info manuals (only if you are building out of CVS, and
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
60 if you have makeinfo.exe installed):
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
61
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
62 make info
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
63
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
64 (change "make" to "nmake" if you use MSVC).
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
65
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
66 5. Install the produced binaries:
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
67
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
68 make install
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
69
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
70 That's it!
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
71
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
72 If these short instructions somehow fail, read the rest of this
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
73 file.
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
74
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
75 * Preliminaries
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
76
39152
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
77 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
78 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
79 WinZip is known to create some subtle and hard to debug problems,
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49565
diff changeset
80 such as converting files to DOS CR-LF format, not creating empty
39152
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
81 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
82 site.
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
83
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
84 If you are building out of CVS, then some files in this directory
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
85 (.bat files, nmake.defs and makefile.w32-in) may need the line-ends
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
86 fixing first. The easiest way to do this and avoid future conflicts
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
87 is to run the following command in this (emacs/nt) directory:
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
88
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
89 cvs update -kb
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
90
63571
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
91 Alternatively, use programs that convert end-of-line format, such as
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
92 dos2unix and unix2dos available from GnuWin32 or dtou and utod from
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
93 the DJGPP project.
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
94
57565
5bab1954e91f Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
parents: 55977
diff changeset
95 In addition to this file, you should also read INSTALL.CVS in the
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
96 parent directory, and make sure that you have a version of
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
97 "touch.exe" in your path, and that it will create files that do not
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
98 yet exist.
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
99
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
100 * Supported development environments
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
101
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
102 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>
parents: 57697
diff changeset
103 later and nmake, or a Windows port of GCC 2.95 or later with MinGW
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
104 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>
parents: 57697
diff changeset
105 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
106 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
107 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
108
74937
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
109 Note that building Emacs with Visual Studio 2005 is not supported at
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
110 this time.
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
111
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
112 The rest of this file assumes you have a working development
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
113 environment. If you just installed such an environment, try
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
114 building a trivial C "Hello world" program, and see if it works. If
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
115 it doesn't work, resolve that problem first!
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
116
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
117 If you use the MinGW port of GCC and GNU Make to build Emacs, there
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
118 are some compatibility issues wrt Make and the shell that is run by
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
119 Make, either the standard COMMAND.COM/CMD.EXE supplied with Windows
73297
f4d7960fe496 Add compatibility data for Cygwin Make 3.81.
Eli Zaretskii <eliz@gnu.org>
parents: 72141
diff changeset
120 or sh.exe., a port of a Unixy shell. For reference, below is a list
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
121 of which builds of GNU Make are known to work or not, and whether
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
122 they work in the presence and/or absence of sh.exe, the Cygwin port
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
123 of Bash. Note that any version of Make that is compiled with Cygwin
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
124 will only work with Cygwin tools, due to the use of cygwin style
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
125 paths. This means Cygwin Make is unsuitable for building parts of
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
126 Emacs that need to invoke Emacs itself (leim and "make bootstrap",
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
127 for example). Also see the Trouble-shooting section below if you
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
128 decide to go ahead and use Cygwin make.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
129
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
130 In addition, using 4NT as your shell is known to fail the build process,
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
131 at least for 4NT version 3.01. Use CMD.EXE, the default Windows shell,
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
132 instead. MSYS sh.exe also appears to cause various problems. If you have
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
133 MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
134 instead of sh.exe.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
135
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
136 sh exists no sh
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
137
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
138 cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
139 MSVC compiled gmake 3.77: okay okay
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
140 MSVC compiled gmake 3.78.1: okay okay
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
141 MSVC compiled gmake 3.79.1: okay okay
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
142 mingw32/gcc-2.92.2 make (3.77): okay okay[4]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
143 cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
144 cygwin compiled make 3.78.1: fails[5] fails[2, 5]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
145 cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5]
73297
f4d7960fe496 Add compatibility data for Cygwin Make 3.81.
Eli Zaretskii <eliz@gnu.org>
parents: 72141
diff changeset
146 cygwin compiled make 3.80: fails?[6] fails?[6]
f4d7960fe496 Add compatibility data for Cygwin Make 3.81.
Eli Zaretskii <eliz@gnu.org>
parents: 72141
diff changeset
147 cygwin compiled make 3.81: fails fails?[6]
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
148 mingw32 compiled make 3.79.1: okay okay
74937
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
149 mingw32 compiled make 3.80: okay okay[6]
71164
1f33ca9aff72 Add Make 3.81 to the list of Make & shell combinations known to work.
Eli Zaretskii <eliz@gnu.org>
parents: 69567
diff changeset
150 mingw32 compiled make 3.81: okay okay[7]
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
151
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
152 Notes:
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
153
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
154 [1] doesn't cope with makefiles with DOS line endings, so must mount
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
155 emacs source with text!=binary.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
156 [2] fails when needs to invoke shell commands; okay invoking gcc etc.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
157 [3] requires LC_MESSAGES support to build; cannot build with early
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
158 versions of cygwin.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
159 [4] may fail on Windows 9X and Windows ME; if so, install Bash.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
160 [5] fails when building leim due to the use of cygwin style paths.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
161 May work if building emacs without leim.
74937
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
162 [6] not recommended; please report if you try this combination.
71594
faad62bfa898 Add the missing comment [7].
Eli Zaretskii <eliz@gnu.org>
parents: 71548
diff changeset
163 [7] tested only on Windows XP.
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
164
49871
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
165 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>
parents: 49600
diff changeset
166 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>
parents: 49600
diff changeset
167 Emacs executable with strange filename completion behaviour. Unless
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
168 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>
parents: 49600
diff changeset
169 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>
parents: 49600
diff changeset
170 in the previous paragraph.
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
171
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
172 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>
parents: 57697
diff changeset
173 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>
parents: 57697
diff changeset
174 projects:
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
175
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
176 * 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>
parents: 57697
diff changeset
177 * http://www.mingw.org/ ( MinGW )
62677
850c9d934e12 Stupid, stupid me.
Juanma Barranquero <lekktu@gmail.com>
parents: 62675
diff changeset
178 * 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>
parents: 57697
diff changeset
179 * 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>
parents: 55977
diff changeset
180
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
181 If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
182 Windows NT, we suggest to install the Cygwin port of Bash. That is
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
183 because the native Windows shell COMMAND.COM is too limited; the
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
184 Emacs build procedure tries very hard to support even such limited
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
185 shells, but as none of the Windows developers of Emacs work on
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
186 Windows 9x, we cannot guarantee that it works without a more
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
187 powerful shell.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
188
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
189 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>
parents: 57697
diff changeset
190 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>
parents: 57697
diff changeset
191
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
192 http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
193
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
194 and at this URL:
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
195
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
196 http://ourcomments.org/Emacs/w32-build-emacs.html
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
197
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
198 * Configuring
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
199
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
200 Configuration of Emacs is now handled by running configure.bat in the
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
201 `nt' subdirectory. It will detect which compiler you have available,
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
202 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
203 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
204 options on the command line when invoking configure.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
205
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
206 To configure Emacs to build with GCC or MSVC, whichever is available,
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
207 simply change to the `nt' subdirectory and run `configure.bat' with no
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
208 options. To see what options are available, run `configure --help'.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
209
31625
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
210 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
211 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
212 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
213
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
214 You are encouraged to look at the file config.log which shows details
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
215 for failed tests, after configure.bat finishes. Any unexplained failure
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
216 should be investigated and perhaps reported as a bug (see the section
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
217 about reporting bugs in the file README in this directory and in the
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
218 Emacs manual).
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
219
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
220 * Optional image library support
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
221
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
222 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>
parents: 52416
diff changeset
223 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>
parents: 52416
diff changeset
224 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>
parents: 52416
diff changeset
225 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>
parents: 52416
diff changeset
226 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>
parents: 52416
diff changeset
227 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>
parents: 52416
diff changeset
228 to configure.bat. The configure script will report whether it was
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
229 able to detect the headers. If the results of this testing appear to be
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
230 incorrect, please look for details in the file config.log: it will show
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
231 the failed test programs and compiler error messages that should explain
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
232 what is wrong. (Usually, any such failures happen because some headers
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
233 are missing due to bad packaging of the image support libraries.)
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
234
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
235 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>
parents: 57697
diff changeset
236 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>
parents: 57697
diff changeset
237 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>
parents: 57697
diff changeset
238 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>
parents: 57697
diff changeset
239 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>
parents: 57697
diff changeset
240 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>
parents: 57697
diff changeset
241 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>
parents: 57697
diff changeset
242 expected names of the libraries.
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
243
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
244 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>
parents: 52416
diff changeset
245 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>
parents: 52416
diff changeset
246 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>
parents: 52416
diff changeset
247 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>
parents: 52416
diff changeset
248 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>
parents: 52416
diff changeset
249
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
250 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>
parents: 57697
diff changeset
251 the GnuWin32 project. These are built with MinGW, but they can be
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
252 used with both GCC/MinGW and MSVC builds of Emacs. See the info on
63319
382121c868f8 Update the URL of the Emacs Windows build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 63308
diff changeset
253 http://ourcomments.org/Emacs/EmacsW32.html for more details about
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
254 installing image support libraries.
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
255
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
256 * Building
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
257
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
258 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
259 your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
260 GNU make. (If you are building out of CVS, say "make bootstrap" or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
261 "nmake bootstrap" instead.)
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
262
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
263 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
264 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
265 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
266 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
267 until then we will just live with them.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
268
74820
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
269 With GNU Make, you can use the -j command-line option to have Make
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
270 execute several commands at once, like this:
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
271
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
272 gmake -j 4 XMFLAGS="-j 3"
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
273
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
274 The XMFLAGS variable overrides the default behavior of GNU Make on
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
275 Windows, whereby recursive Make invocations reset the maximum number
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
276 of simultaneous commands to 1. The above command allows up to 4
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
277 simultaneous commands at once in the top-level Make, and up to 3 in
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
278 each one of the recursive Make's; you can use other numbers of jobs,
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
279 if you wish.
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
280
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
281 If you are building from CVS, the following commands will produce
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
282 the Info manuals (which are not part of the CVS repository):
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
283
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
284 make info
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
285 or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
286 nmake info
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
287
71548
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
288 Note that you will need makeinfo.exe (from the GNU Texinfo package)
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
289 in order for this command to succeed.
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
290
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
291 * Installing
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
292
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
293 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
294 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
295 do you have.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
296
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
297 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
298 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
299 --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
300 make, like so:
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
301
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
302 make install INSTALL_DIR=D:/emacs
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
303
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
304 (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
305
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
306 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
307 to create a Start menu icon for Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
308
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
309 * Trouble-shooting
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
310
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
311 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>
parents: 57697
diff changeset
312 Emacs stem from using an old version of GCC, or old MinGW or W32 API
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
313 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
314 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
315 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
316 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
317 --unix on the command line, or MAKE_MODE=UNIX in the environment.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
318
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
319 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
320 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
321 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
322 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
323 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
324 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
325 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
326 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
327 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
328 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
329 1999-11-18 onwards are okay.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
330
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
331 When in doubt about correctness of what configure did, look at the file
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
332 config.log, which shows all the failed test programs and compiler
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
333 messages associated with the failures. If that doesn't give a clue,
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
334 please report the problems, together with the relevant fragments from
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
335 config.log, as bugs.
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
336
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
337 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
338 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
339 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
340 for Makefile's used by Emacs.)
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
341
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
342 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
343 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
344
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
345 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
346 --ldflags -mwin32
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
347
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
348 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
349 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
350
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
351 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
352 release.
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
353
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
354 * Debugging
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
355
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
356 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
357 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>
parents: 67016
diff changeset
358 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>
parents: 67016
diff changeset
359
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
360 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>
parents: 67016
diff changeset
361 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>
parents: 67016
diff changeset
362 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>
parents: 67016
diff changeset
363 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>
parents: 67016
diff changeset
364 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>
parents: 67016
diff changeset
365 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>
parents: 67016
diff changeset
366 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>
parents: 67016
diff changeset
367 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>
parents: 67016
diff changeset
368 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>
parents: 67016
diff changeset
369 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>
parents: 67016
diff changeset
370 error.
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
371
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
372 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
373 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
374 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
375 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
376 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
377 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
378 easily set breakpoints or examine familiar lisp variables by name.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
379
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
380 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>
parents: 67016
diff changeset
381 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>
parents: 67016
diff changeset
382 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>
parents: 67016
diff changeset
383 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>
parents: 67016
diff changeset
384 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>
parents: 67016
diff changeset
385 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>
parents: 67016
diff changeset
386 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>
parents: 67016
diff changeset
387
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
388 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>
parents: 67016
diff changeset
389 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>
parents: 67016
diff changeset
390 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>
parents: 67016
diff changeset
391 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>
parents: 67016
diff changeset
392 should be displayed in its "Debug" output window.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
393
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
394 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
395 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
396 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
397 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
398 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
399 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
400 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
401 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
402 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
403 (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
404 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
405 then print out the contents of the lisp variable exec-path.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
406
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
407 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
408 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
409 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
410 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
411 procedure and try using debug_print again.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
412
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
413 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
414 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
415 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
416 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
417 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
418 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
419 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
420 threads.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
421
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
422 COPYING PERMISSIONS
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
423
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
424 Permission is granted to anyone to make or distribute verbatim copies
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
425 of this document as received, in any medium, provided that the
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
426 copyright notice and permission notice are preserved,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
427 and that the distributor grants the recipient permission
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
428 for further redistribution as permitted by this notice.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
429
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
430 Permission is granted to distribute modified versions
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
431 of this document, or of portions of it,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
432 under the above conditions, provided also that they
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
433 carry prominent notices stating who last changed them,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
434 and that any new or changed statements about the activities
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
435 of the Free Software Foundation are approved by the Foundation.