help-fns.el (describe-function-or-variable): New function on `C-h o'
[emacs.git] / admin / make-emacs
blobf0c5370496e21f0a8e548bdc91c7018e924e8924
1 #! /usr/bin/perl
2 # Build Emacs with various options for profiling, debugging,
3 # with and without warnings enabled etc.
5 # Copyright (C) 2001-2015 Free Software Foundation, Inc.
7 # This file is part of GNU Emacs.
9 # GNU Emacs is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
14 # GNU Emacs is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 require 5;
24 use strict;
25 use warnings;
26 use Getopt::Long;
27 use File::Basename;
28 use Cwd;
30 # Default CVS sandbox directory. Only used when called from outside
31 # of the sandbox.
33 $root = $ENV{"EMACS_ROOT"};
34 $root = "/gd/gnu/emacs" unless $root;
36 # Default make command.
38 $make = $ENV{"EMACS_MAKE"};
39 $make = "gmake" unless $make;
41 $rc = GetOptions ("help" => \$help,
42 "enable-checking" => \$enable_checking,
43 "no-warn" => \$no_warn,
44 "check-marked" => \$check_marked,
45 "all" => \$all,
46 "no-optim" => \$no_optim,
47 "check-lisp-type" => \$check_lisp_type,
48 "gprof" => \$profile,
49 "malloc-check" => \$malloc_check,
50 "no-mcheck" => \$no_mcheck,
51 "alias" => \$aliasing,
52 "boot" => \$boot,
53 "wall" => \$wall,
54 "gcc3" => \$gcc3,
55 "trace-selection" => \$trace_selection,
56 "trace-move" => \$trace_move,
57 "stabs" => \$use_stabs,
58 "optim" => \$optim);
60 if ($rc == 0 || $help)
62 print <<USAGE;
63 make-emacs [options] ...
65 Build Emacs.
67 --help show this help
68 --all make clean versionclean first
69 --boot make bootstrap, log to boot.log
70 --enable-checking ENABLE_CHECKING=1
71 --no-warn disable warnings
72 --check-marked GC_CHECK_MARKED_OBJECTS=1
73 --optim no debug defines
74 --gprof make Emacs for profiling
75 --check-lisp-type define CHECK_LISP_OBJECT_TYPE
76 --malloc-check define GC_MALLOC_CHECK
77 --no-mcheck don't define GC_MCHECK
78 --wall compile with -Wall
79 --gcc3 use GCC 3.0 (30% slower compilation, slower code)
80 --trace-selection print traces in xselect.c
81 --trace-move print traces for move_it* functions
82 --stabs use -gstabs instead -g
84 Default is to compile with warnings, with -DGC_MCHECK=1, and
85 with -DGLYPH_DEBUG=1.
87 USAGE
88 exit 1;
91 # Chdir to the top-level directory of the tree. If not in a tree
92 # containing Emacs, use the default.
94 while (! -f "src/emacs.c" && cwd () ne "/")
96 chdir "..";
99 chdir $root if cwd () eq "/";
100 chdir "./src";
101 print "Build in ", cwd (), "\n";
103 # If first arg is `all' or if `--all' specified, ensure a clean
104 # build.
106 if (@ARGV && $ARGV[0] eq "all")
108 $all = 1;
109 shift @ARGV;
112 system ("$make clean versionclean") if $all;
114 if ($wall)
116 $warn = "-Wall";
118 elsif (!$no_warn)
120 $warn = "-Wpointer-arith -Wchar-subscripts -Wformat -Wimplicit-int";
121 $warn = "$warn -Wreturn-type -Wswitch -Wuninitialized";
124 $defs = "-DGLYPH_DEBUG=1" unless $optim;
125 $defs = "$defs -DGC_CHECK_MARKED_OBJECTS=1" if $check_marked;
126 $defs = "$defs -DENABLE_CHECKING=1" if $enable_checking;
128 if ($profile)
130 $opts = "-pg";
131 $defs = "$defs -DPROFILING=1";
133 else
135 if ($use_stabs)
137 $opts = "-gstabs";
139 else
141 $opts = "-g";
145 $defs = "$defs -DCHECK_LISP_OBJECT_TYPE" if $check_lisp_type;
146 $defs = "$defs -DGC_MALLOC_CHECK=1 -DGC_PROTECT_MALLOC_STATE=1" if $malloc_check;
147 $defs = "$defs -DGC_MCHECK=1" unless $no_mcheck;
149 $defs = "$defs -DTRACE_SELECTION" if $trace_selection;
150 $defs = "$defs -DDEBUG_TRACE_MOVE" if $trace_move;
152 # arch=pentium leads to slightly faster code than without.
153 $opts = "$opts -march=pentiumpro";
155 if ($optim)
157 $opts = "$opts -pipe -O3";
159 elsif ($no_optim)
161 $opts = "$opts -pipe -fno-inline";
163 else
165 $opts = "$opts -O -pipe -fno-inline";
168 $opts = "$opts -fstrict-aliasing" if $aliasing;
170 $opts = "$opts $defs" if $defs;
171 $opts = "$opts $warn" if $warn;
173 $cc = "/usr/bin/gcc";
174 $cc = "/gd/local/bin/gcc" if $gcc3;
176 if ($boot)
178 chdir "..";
179 system "mv boot.log boot.log.old" if -f "boot.log";
180 exit system "script boot.log $make CC=\"$cc\" CFLAGS=\"$opts\" bootstrap";
183 exit system "$make CC=\"$cc\" CFLAGS=\"$opts\" @ARGV";
185 # Local Variables:
186 # mode: cperl
187 # End: