build / build.texi

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename build.info
@settitle XEmacs Build Reference Manual
@c %**end of header
@setchapternewpage odd
@ifinfo
This document describes the XEmacs package called build.
Copyright @copyright{} 2000-2001 Adrian Aichner.
@end ifinfo

@c @c Combine indices.
@c @synindex cp fn
@c @syncodeindex vr fn
@c @syncodeindex ky fn
@c @syncodeindex pg fn
@c @syncodeindex tp fn

@titlepage
@c @sp 10
@c @comment The title is printed in a large font.
@c @center @titlefont{Build}
@c @c The following two commands start the copyright page.
@c @page
@c @vskip 0pt plus 1filll
@c Copyright @copyright{} 2000 Adrian Aichner.
@title XEmacs Build Reference Manual
@subtitle Version $Name$ (for XEmacs 21.1, 21.2), dated $Date$

@author by Adrian Aichner
@page
@vskip 0pt plus 1filll
@sp 2
@c Version 3.3 @*
@c Revised for XEmacs Versions 21.0,@*
@c April 1998.@*

Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled ``GNU General Public License'' is included
exactly as in the original, and provided that the entire resulting
derived work is distributed under the terms of a permission notice
identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that the section entitled ``GNU General Public License'' may be
included in a translation approved by the Free Software Foundation
instead of in the original English.
@end titlepage
@node Top, Build Overview, , (dir)
@comment node-name, next,          previous, up
@chapter Build Package

This is the XEmacs Build Reference Manual, Version $Name$ (for XEmacs
21.1, 21.2), released $Date$, by @email{adrian@@xemacs.org, Adrian
Aichner}.

@menu
* Build Overview::                    Overview of build package
* Build Installation::                Installation of the build package
* Build XEmacs::                      Choosing source and tools          
* Build XEmacs From CVS::             Fetching sources with @code{CVS}
* Build XEmacs From Tarballs::        Fetching source tarballs with @code{EFS}
* Build XEmacs With GNU Tools::       UNIX-style build using configure, make
* Build XEmacs With Microsoft Tools:: Microsoft build using MS VC++ >= 4.0
* Generate XEmacs Build Report::      Reporting Success or Failure
* Known Problems of Build::           Problems, Workarounds, and Fixes
* Concept Index::                     An item for each concept
@end menu

@node Build Overview, Build Installation, Top, (dir)
@comment node-name,     next,          previous, up
@chapter Build Overview
@cindex What build is

@code{build} supports the building process of the @code{XEmacs} editor
from its sources.

@cindex XEmacs build process

The build process consists of following steps:

@enumerate

@item
Download source code from FTP server or CVS repository.

@item
Configure any attributes of the build process, of the resulting XEmacs
executable, and of the XEmacs environment.

@item
Start the make process to build XEmacs, install it, and run the
regression tests.

@item
Report on the success or failure of the build, using build-report.

@end enumerate

The @code{build} command generates a widget-based interface to configure
and build XEmacs either using GNU Tools (@code{configure}, @code{make})
or Microsoft Tools (@code{nmake} with command-line options (<= 21.2-b32)
or @file{config.inc} configuration file (> 21.2-b32)).

@node Build Installation, Build XEmacs, Build Overview, (dir)
@comment node-name,     next,          previous, up
@chapter Build Installation
@cindex How to install build

You have following three choices to install build (@pxref{Using
Packages, Using Packages, , xemacs}):

@enumerate

@item
Use the package GUI:

@itemize @bullet

@item
In XEmacs Release 21.1:

Select a download site under

@example
Options->Manage Packages->Add Download Site
@end example

and after listing available packages with

@example
Options->Manage Packages->List & Install
@end example

install @code{build} with

@example
Packages->Toggle install `build'
Packages->Install/Remove Selected
@end example

followed by starting a fresh XEmacs.

@item
In XEmacs Beta Release 21.2-bXX:

Menus have been re-arranged in XEmacs 21.2.

Select a download site under

@example
Tools->Packages->Add Download Site
@end example

and after listing available packages with

@example
Tools->Packages->List and Install
@end example

install @code{build} with

@example
Packages->Toggle install `build'
Packages->Install/Remove Selected
@end example
  
followed by starting a fresh XEmacs.

@end itemize

@item
Run XEmacs command

@example
@kbd{M-x package-admin-add-binary-package RET @var{build-package-tarball-path}}
@end example

after tarball download with EFS or ftp.

@item

Extract the build tarball(s) into the xemacs-packages hierarchy from
your favorite shell.

@code{bash}, @code{csh}, @code{ksh}, @code{zsh} come to mind on
@code{UNIX} systems; @code{Cygwin's} @code{bash}, @code{cmd.exe}, and
@code{command.exe} for @code{Windows 95/98/NT}.

@example
@kbd{cd @var{installation-directory}/xemacs-packages;
gzip -dc @var{build-package-tarball-path} | tar -xvf -}
@end example
 
@end enumerate

@node Build XEmacs, Build XEmacs From CVS, Build Installation, Top
@comment node-name,    next,  previous,      up
@chapter Build XEmacs

You may want to read through the build package info documentation first.
It is accessed by following button.

@example
[View Build Info]
@end example

Global build options can be browsed next.

@example
[Browse Build Options ...]
@end example

You have to decide what to @emph{build from}:

@enumerate

@item
CVS sources in the XEmacs CVS repository at
@uref{http://cvs.xemacs.org/}.

@item
Tarballs (tar.gz files) on the XEmacs FTP Site
@uref{http://ftp.xemacs.org/pub/xemacs/} or one of its mirror sites.

@end enumerate

and what to @emph{build with}:

@enumerate

@item
GNU@footnote{Alert readers will note: GNU's Not UNIX!}/UNIX tools using
@code{configure}, @code{make}, and @code{cc}.

@cindex xemacs.mak
@item
Microsoft tools using @code{nmake} and @code{cl}, supported by
@file{nt/xemacs.mak}, and beginning with XEmacs 21.2-b33
@file{nt/config.inc}.

@end enumerate

These two choices determine which of the following steps will be taken.

@example
[Build XEmacs From CVS Now]
@end example

@example
[Build XEmacs From Tarballs Now]
@end example

Finally either press the button labeled @ref{Build XEmacs From CVS}
or @ref{Build XEmacs From Tarballs}.  Only the button labeled according
to your choice under the @emph{build from:} menu will be active.
See @ref{Build XEmacs} and @ref{Known Problems of Build}.

Each of the following steps allow to return to a previous one with the

@cindex Going Back
@example
[Back]
@end example

button to review your choices.

Whether to build from tarballs or CVS sources depends on what the user
wants to do with the sources.

@itemize @bullet

@item
Tarballs are convenient for building a well-defined release of XEmacs.
These tarballs are big and users with slow or expensive network
connections should avoid them.

@code{gzip} and @code{tar} are required for this method.

@item
For users who want to stay in close sync with the development of XEmacs,
especially the Beta releases, create patches against files or whole
directories, CVS is the way to go.

You will obviously need to install @code{cvs} first.

@end itemize

The choice is yours@footnote{unless your access to the Internet is
limited by firewalls or disabled IP ports, you don't have gzip/tar, or
cvs.}.

@node Build XEmacs From CVS, Build XEmacs From Tarballs, Build XEmacs, Top
@comment node-name,    next,  previous,      up
@chapter Build XEmacs From CVS
@cindex Obtaining sources with CVS

The CVS commands to fetch XEmacs source code are run through the XEmacs
@kbd{compile} command (@pxref{Compilation, , , xemacs}).

The buffers are named uniquely with the current working directory
appropriately set to save the buffers with @kbd{C-x C-w} (@kbd{M-x
write-file}) under the XEmacs source directory.

After pressing the 

@example
[CVS Checkout XEmacs]
@end example

button (unless you have
checked out before) and either one of 

@example
[CVS Update XEmacs To Release]
@end example

(as specified with

@example
[Browse Build CVS Options ...]
@end example

) or

@example
[CVS Update XEmacs To Latest]
@end example

(resetting all @pxref{Sticky tags, , , cvs}) you are ready to proceed
with

@example
[Build XEmacs Now ...]
@end example

@node Build XEmacs From Tarballs, Build XEmacs With GNU Tools, Build XEmacs From CVS, Top
@comment node-name,    next,  previous,      up
@chapter Build XEmacs From Tarballs
@cindex Obtaining sources with EFS

The tarballs chosen with 

@example
[Browse Build Tarball Options ...]
@end example

Press

@example
[Download Build Tarball Set]
@end example

to fetch tarballs with @code{EFS}, which needs to be installed
@footnote{If @code{EFS} is not installed you may obtain these tarballs
by other means and extract them to the configured directory.}, followed
by

@example
[Install Downloaded Build Tarball Set]
@end example

to extract tarballs using @code{gzip} and @code{tar} in a
@code{compilation-mode} buffer named accordingly (e.g. ???).

Finally press the button either labeled @ref{Build XEmacs With GNU
Tools} or @ref{Build XEmacs With Microsoft Tools} according to your
choice under the @emph{build with:} menu.  See @ref{Build XEmacs}.

@node Build XEmacs With GNU Tools, Build XEmacs With Microsoft Tools, Build XEmacs From Tarballs, Top
@comment node-name,    next,  previous,      up
@chapter Build XEmacs With GNU Tools
@cindex Building on UNIX
@cindex configure
@cindex configure.usage
@cindex make
@cindex gcc

Besides @code{GNU make} (make) and @code{GNU cc} (gcc) XEmacs can be built with the
equivalent programs from many UNIX vendors.

The @dfn{configure}@footnote{This shell script is on the top-level of
the XEmacs source tree, see also configure.usage there.} script, which
is run before @code{make}, determines the configuration of your system
and warns about any problems it finds.

@node Build XEmacs With Microsoft Tools, Generate XEmacs Build Report, Build XEmacs With GNU Tools, Top
@comment node-name,    next,  previous,      up
@chapter Build XEmacs With Microsoft Tools
@cindex Building on Windows 95/98/NT
@cindex Building with MS Visual Studio C++
@cindex nmake
@cindex cl
@cindex config.inc

XEmacs is built using Microsoft's version of @code{make}, @dfn{nmake},
and Microsoft's C++ compiler, @dfn{cl}, which are both part of Microsoft
Visual Studio @footnote{Version 4.0 or greater is required.}.

Up to XEmacs 21.2-b32 all configuration choices are passed on to
@code{nmake} as command-line options.

XEmacs versions > 21.2-b32
support @file{nt/config.inc} which is generated according to user
choices made under 

@example
[Customize Build Make ...]
@end example

by

@example
[Generate config.inc]
@end example

which you have to save after reviewing it shortly.

@node Generate XEmacs Build Report, Known Problems of Build, Build XEmacs With Microsoft Tools, Top
@comment node-name,    next,  previous,      up
@chapter Generate XEmacs Build Report

This is a GUI making use of the @code{build-report} feature provided
with XEmacs.

You have to first

@example
[Customize Build Report ...]
@end example

to pick up the information for the XEmacs build you would like to
generate the report for.

Currently @code{build-report.el} is bundled with @code{build} to support
XEmacs 21.1, which doesn't have the latest version.

@node Known Problems of Build, Concept Index, Generate XEmacs Build Report, Top
@chapter Known Problems of Build
@cindex Limitations
@cindex Bugs

@enumerate

@item
Activated buttons appear to be inactive.

@itemize @bullet

@item
Problem

The buttons
@example
[Build XEmacs From CVS Now]
@end example
and
@example
[Build XEmacs From Tarballs Now]
@end example
don't show as active after being re-activated due to a bug in
wid-edit.el in XEmacs 21.1.12 and below.

@item
Workaround

You can easily find which button is active by using
@kbd{TAB} runs `widget-forward'
or
@kbd{Sh-TAB} runs `widget-backward'.

@item
Fix

@uref{http://www.xemacs.org/list-archives/xemacs-patches/200010/msg00031.html}
should fix this problem for later versions of XEmacs.

@end itemize

@item
Inactive buttons appear to be active.

@itemize @bullet

@item
Problem

XEmacs 21.2-b36 and below have another bug which will not render the
de-activated button as such.

@item
Workaround

You can easily find which button is active by using
@kbd{TAB} runs `widget-forward'
or
@kbd{Sh-TAB} runs `widget-backward'.

@item
Fix

None as of 2000-10-21.  See
@uref{http://www.xemacs.org/list-archives/xemacs-beta/200010/msg00194.html}.

@end itemize

@end enumerate

@node Concept Index, , Known Problems of Build, Top
@comment node-name,    next,  previous,      up
@unnumbered Concept Index
@printindex cp
@contents
@bye
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.