annotate man/beta.texi @ 2592:184e0369d6e6

[xemacs-hg @ 2005-02-17 22:51:50 by viteno] Update xemacs_extra_name.
author viteno
date Thu, 17 Feb 2005 22:51:50 +0000
parents a9527fcdf77f
children 89e2f8e3f660
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
2
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
3 @c This file is in Texinfo format.
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
4 @c If for some reason you do not have the formatted version available,
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
5 @c this file is more or less readable as plain text.
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
6 @c Skip to the line beginning "@node Introduction".
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
7
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
8 @c %**start of header
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
9 @setfilename ../info/beta.info
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
10 @settitle Info on beta versions of XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
11 @direntry
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
12 * Beta: (beta). Info on beta versions of XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
13 @end direntry
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
14 @c footnotestyle separate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
15 @c paragraphindent 2
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
16 @c %**end of header
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
17
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
18 @ifinfo
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
19 This file describes info relevant to beta versions of XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
20
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
21 Copyright @copyright{} 2005 Ben Wing.
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
22 Copyright @copyright{} 2005 Free Software Foundation, Inc.
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
23
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
24 This file is part of XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
25
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
26 XEmacs is free software; you can redistribute it and/or modify it
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
27 under the terms of the GNU General Public License as published by the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
28 Free Software Foundation; either version 2, or (at your option) any
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
29 later version.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
30
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
31 XEmacs is distributed in the hope that it will be useful, but WITHOUT
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
32 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
33 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
34 for more details.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
35
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
36 You should have received a copy of the GNU General Public License
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
37 along with XEmacs; see the file COPYING. If not, write to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
38 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
39 Boston, MA 02111-1307, USA.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
40 @end ifinfo
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
41
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
42 @c Combine indices.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
43 @syncodeindex fn cp
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
44 @syncodeindex vr cp
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
45 @syncodeindex ky cp
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
46 @syncodeindex pg cp
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
47 @syncodeindex tp cp
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
48
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
49 @setchapternewpage odd
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
50 @finalout
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
51
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
52 @titlepage
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
53 @title Info on beta versions of XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
54
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
55 @author XEmacs Development Team
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
56 @page
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
57 @vskip 0pt plus 1fill
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
58
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
59 @noindent
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
60 Copyright @copyright{} 2005 Ben Wing. @*
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
61
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
62 This file is part of XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
63
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
64 XEmacs is free software; you can redistribute it and/or modify it
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
65 under the terms of the GNU General Public License as published by the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
66 Free Software Foundation; either version 2, or (at your option) any
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
67 later version.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
68
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
69 XEmacs is distributed in the hope that it will be useful, but WITHOUT
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
70 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
71 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
72 for more details.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
73
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
74 You should have received a copy of the GNU General Public License
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
75 along with XEmacs; see the file COPYING. If not, write to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
76 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
77 Boston, MA 02111-1307, USA.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
78 @end titlepage
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
79 @page
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
80
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
81 @ifinfo
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
82 @node Top, Introduction, (dir), (dir)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
83 This Info file describes info relevant to beta versions of XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
84 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
85 * Introduction::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
86 * Compiling Beta XEmacs::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
87 * Packages::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
88 * Improving XEmacs::
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
89 * Index::
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
90
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
91 @detailmenu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
92 --- The Detailed Node Listing ---
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
93
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
94 Introduction
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
95
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
96 * Mailing Lists::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
97 * Beta Release Schedule::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
98 * Reporting Problems::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
99 * Getting the Source::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
100
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
101 Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
102
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
103 * XEmacs Beta Mailing List::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
104 * XEmacs Patches Mailing List::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
105 * XEmacs Design Mailing List::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
106 * List Administrivia::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
107 * Managing your subscription via the Web::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
108 * Subscribing by e-mail::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
109 * Unsubscribing by e-mail::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
110
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
111 Compiling Beta XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
112
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
113 * Building an XEmacs from patches::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
114 * Building XEmacs from a full distribution::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
115
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
116 Packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
117
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
118 * Binary package installation::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
119 * Manual procedures for package management::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
120 * Building XEmacs and XEmacs packages from scratch::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
121
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
122 Improving XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
123
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
124 * Creating patches for submission::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
125 * Large contributions::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
126
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
127 Creating patches for submission
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
128
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
129 * Patch discussion etiquette::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
130
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
131 Large contributions
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
132
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
133 * Updates to existing packages::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
134 * New packages::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
135 * Syncing with GNU Emacs::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
136
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
137 @end detailmenu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
138 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
139
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
140 @end ifinfo
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
141
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
142 @node Introduction, Compiling Beta XEmacs, Top, Top
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
143 @chapter Introduction
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
144
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
145 You are running a potentially unstable version of XEmacs. Please do
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
146 not report problems with Beta XEmacs to comp.emacs.xemacs. Report
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
147 them to @uref{mailto:xemacs-beta@@xemacs.org}, preferably with
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
148 @kbd{M-x report-xemacs-bug RET}.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
149
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
150 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
151 * Mailing Lists::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
152 * Beta Release Schedule::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
153 * Reporting Problems::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
154 * Getting the Source::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
155 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
156
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
157 @node Mailing Lists, Beta Release Schedule, Introduction, Introduction
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
158 @section Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
159
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
160 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
161 * XEmacs Beta Mailing List::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
162 * XEmacs Patches Mailing List::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
163 * XEmacs Design Mailing List::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
164 * List Administrivia::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
165 * Managing your subscription via the Web::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
166 * Subscribing by e-mail::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
167 * Unsubscribing by e-mail::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
168 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
169
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
170 @node XEmacs Beta Mailing List, XEmacs Patches Mailing List, Mailing Lists, Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
171 @subsection XEmacs Beta Mailing List
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
172
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
173 If you are not subscribed to the XEmacs beta list you should be.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
174 Currently all discussion of development issues, including bug reports
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
175 and coding discussion, takes place on the XEmacs Beta mailing list.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
176 Only patches and administrative actions regarding patches are sent
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
177 elsewhere (to the XEmacs Patches list).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
178
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
179 @node XEmacs Patches Mailing List, XEmacs Design Mailing List, XEmacs Beta Mailing List, Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
180 @subsection XEmacs Patches Mailing List
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
181
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
182 XEmacs Patches records proposed changes to XEmacs, and their
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
183 disposition. It is open subscription, and all patches that are
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
184 seriously proposed for inclusion in XEmacs should be posted here. You
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
185 can follow progress of your patch by subscribing to the mailing list
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
186 or in the archives.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
187
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
188 Besides patches, only actions by members of the XEmacs Review Board
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
189 should be posted to this list. All discussion should be redirected to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
190 XEmacs Beta or XEmacs Design.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
191
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
192 @node XEmacs Design Mailing List, List Administrivia, XEmacs Patches Mailing List, Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
193 @subsection XEmacs Design Mailing List
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
194
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
195 XEmacs Design is for design discussions such as adding major features
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
196 or whole modules, or reimplementation of existing functions, to XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
197
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
198 @node List Administrivia, Managing your subscription via the Web, XEmacs Design Mailing List, Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
199 @subsection List Administrivia
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
200
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
201 In the descriptions below, the word LIST (all uppercase) is a
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
202 variable. Substitute "beta", "design", or "patches" as appropriate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
203 (to get "xemacs-beta" as the mailbox for the XEmacs Beta mailing list,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
204 or @uref{http://www.xemacs.org/Lists/#xemacs-beta} for its URL).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
205
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
206 The XEmacs mailing lists are managed by the Mailman mailing list package,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
207 and the usual Mailman commands work. Do not send mailing list requests to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
208 the main address (@uref{mailto:xemacs-LIST@@xemacs.org}), always send them
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
209 to @uref{mailto:xemacs-LIST-request@@xemacs.org}. If you have problems with
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
210 the list itself, they should be brought to the attention of the XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
211 Mailing List manager @uref{mailto:list-manager@@xemacs.org} (the same
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
212 mailbox, "list-manager", for all lists). All public mailing lists have
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
213 searchable archives. The URL is
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
214
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
215 @uref{http://list-archive.xemacs.org/xemacs-LIST}
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
216
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
217 Note that the xemacs-LIST-admin address is used internally by the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
218 Mailman software; it is NOT a synonym for xemacs-LIST-request.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
219
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
220 @node Managing your subscription via the Web, Subscribing by e-mail, List Administrivia, Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
221 @subsection Managing your subscription via the Web
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
222
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
223 Subscription, unsubscription, and options (such as digests and
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
224 temporarily suspending delivery) can be accomplished via the web
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
225 interface at @uref{http://www.xemacs.org/Lists/#xemacs-LIST}.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
226
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
227 @node Subscribing by e-mail, Unsubscribing by e-mail, Managing your subscription via the Web, Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
228 @subsection Subscribing by e-mail
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
229
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
230 Send an email message to @uref{mailto:xemacs-LIST-request@@xemacs.org} with
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
231 @samp{subscribe} (without the quotes) as the BODY of the message.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
232
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
233 @node Unsubscribing by e-mail, , Subscribing by e-mail, Mailing Lists
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
234 @subsection Unsubscribing by e-mail
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
235
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
236 Send an email message to @uref{mailto:xemacs-LIST-request@@xemacs.org} with
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
237 @samp{unsubscribe} (without the quotes) as the BODY of the message.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
238
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
239 @node Beta Release Schedule, Reporting Problems, Mailing Lists, Introduction
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
240 @section Beta Release Schedule
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
241
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
242 We would like to achieve a weekly or fortnightly release cycle (you
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
243 know the Open Source model: release early, release often), and in a
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
244 perfect world that would indeed be the case. There are at least three
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
245 things that often get in the way of that goal: 1) The Release Manager
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
246 has a life outside of XEmacs (hard to believe, I know, but true),
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
247 2) we like to make releases that will build (at least on the Release
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
248 Manager's box), and 3) Murphy likes to throw a spanner in the works
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
249 right when you least expect it (Murphy's Law: Whatever can go wrong,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
250 will go wrong).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
251
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
252 If you'd like to keep right up to date and ride the bleeding edge, use
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
253 CVS (see @uref{http://www.xemacs.org/Develop/cvsaccess.html}). If you
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
254 can't use CVS for some reason and must use FTP, please let us know.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
255 it will make it more likely that we release betas more often.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
256
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
257
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
258 @node Reporting Problems, Getting the Source, Beta Release Schedule, Introduction
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
259 @section Reporting Problems
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
260
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
261 The best way to get problems fixed in XEmacs is to submit good problem
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
262 reports, @kbd{M-x report-xemacs-bug RET} will help you do this (assuming
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
263 you have a usable XEmacs). Since this is beta software, problems are
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
264 certain to exist. Please read through all of part II of the XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
265 FAQ for an overview of problem reporting. Other items which are most
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
266 important are:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
267
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
268 @enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
269 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
270 Do not submit C stack backtraces without line numbers. Since it
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
271 is possible to compile optimized with debug information with GCC
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
272 it is never a good idea to compile XEmacs without the -g flag.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
273 XEmacs runs on a variety of platforms, and often it is not
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
274 possible to recreate problems which afflict a specific platform.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
275 The line numbers in the C stack backtrace help isolate where the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
276 problem is actually occurring.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
277
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
278 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
279 Attempt to recreate the problem starting with an invocation of
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
280 XEmacs with @code{xemacs -no-autoloads}. Quite often, problems are
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
281 due to package interdependencies, and the like. An actual bug
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
282 in XEmacs should be reproducible in a default configuration
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
283 without loading any special packages (or the one or two specific
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
284 packages that cause the bug to appear). If you have trouble
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
285 getting anything to work at all with the above invocation, use
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
286 @code{xemacs -vanilla} instead. If you need to load your user init
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
287 file or the site file to get the problem to occur, then it has
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
288 something to do with them, and you should try to isolate the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
289 issue in those files.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
290
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
291 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
292 A picture can be worth a thousand words. When reporting an
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
293 unusual display, it is generally best to capture the problem in a
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
294 screen dump and include that with the problem report. The easiest
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
295 way to get a screen dump is to use the xv program and its grab
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
296 function. Save the image as a GIF to keep bandwidth requirements
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
297 down without loss of information. MIME is the preferred method
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
298 for making the image attachments.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
299 @end enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
300
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
301 @node Getting the Source, , Reporting Problems, Introduction
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
302 @section Getting the Source
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
303
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
304 In addition to the normal tar distribution, XEmacs source is now
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
305 available via CVS. Please see
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
306
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
307 @uref{http://www.xemacs.org/Develop/cvsaccess.html}
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
308
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
309 @node Compiling Beta XEmacs, Packages, Introduction, Top
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
310 @chapter Compiling Beta XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
311
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
312 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
313 * Building an XEmacs from patches::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
314 * Building XEmacs from a full distribution::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
315 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
316
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
317 @node Building an XEmacs from patches, Building XEmacs from a full distribution, Compiling Beta XEmacs, Compiling Beta XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
318 @section Building an XEmacs from patches
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
319
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
320 All beta releases of XEmacs are included with patches from the previous
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
321 version in an attempt to keep bandwidth requirements down. Patches
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
322 should be applied with the GNU patch program in something like the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
323 following. Let's say you're upgrading XEmacs 21.5-beta9 to XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
324 21.5-beta10 and you have a full unmodified XEmacs 21.5-beta9 source
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
325 tree to work with. Change to the top level directory and issue the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
326 shell command:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
327
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
328 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
329 $ gunzip -c /tmp/xemacs-21.5.9-21.5.10.patch.gz | patch -p1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
330 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
331
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
332 After patching, check to see that no patches were missed by doing
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
333
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
334 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
335 $ find . -name \*.rej -print
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
336 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
337
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
338 Any rejections should be treated as serious problems to be resolved
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
339 before building XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
340
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
341 After seeing that there were no rejections, issue the commands
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
342
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
343 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
344 $ ./config.status --recheck
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
345 $ make beta > ./beta.err 2>&1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
346 $ make check > ./xemacs-make-check.err 2>&1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
347 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
348
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
349 Redirect the output from make to those files because you'll use them
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
350 later when you send off a build report with @kbd{M-x build-report RET}
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
351
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
352 @node Building XEmacs from a full distribution, , Building an XEmacs from patches, Compiling Beta XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
353 @section Building XEmacs from a full distribution
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
354
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
355 @enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
356 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
357 Locate a convenient place where you have at least 100MB of free space
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
358 and issue the command
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
359
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
360 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
361 $ gunzip -c /tmp/xemacs-21.5.10.tar.gz | tar xvf -
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
362 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
363
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
364 (or simply @code{tar zxvf /tmp/xemacs-21.5.10.tar.gz} if you use GNU tar).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
365
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
366 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
367 cd to the top level directory and issue an appropriate configure
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
368 command.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
369
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
370 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
371 Run @code{configure}. If you are new, just consider running it with no
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
372 options, to see if you can get a succesful build. When you are more
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
373 experienced, you should put various flags in. Here is what we suggest:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
374
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
375 @enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
376 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
377 It's a good idea to use
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
378
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
379 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
380 --extra-verbose
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
381 --debug
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
382 --memory-usage-stats
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
383 --error-checking=all
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
384 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
385
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
386 These turn on extra debugging info and checks. The last one in particular
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
387 will add a great deal of extra error-checking -- which will slow your XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
388 down somewhat but is likely to catch bugs much sooner and make your bug
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
389 reports much more useful.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
390
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
391 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
392 You should also strongly consider
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
393
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
394 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
395 --with-mule
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
396 --use-pkcc
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
397 --pdump
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
398 --with-clash-detection
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
399 --with-wmcommand
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
400 --with-xfs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
401 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
402
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
403 These turn on optional features, which can always use testing.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
404
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
405 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
406 If you have gcc, consider using
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
407
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
408 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
409 --compiler=gcc
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
410 --xemacs-compiler=g++
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
411 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
412
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
413 This will compile XEmacs using g++, which will turn on a lot of additional
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
414 error-checking.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
415
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
416 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
417 If your packages are not installed under /usr/local, you should add a
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
418 line like
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
419
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
420 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
421 --package-path=~/.xemacs::/xemacs/site-packages:/xemacs/xemacs-packages:/xemacs/mule-packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
422 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
423
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
424 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
425 If you want to build multiple configurations from the same source
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
426 tree, make separate build directories for each configuration, run
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
427 @code{configure} from the top level of these (currently empty)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
428 directories and use an option like
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
429
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
430 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
431 --srcdir=/xemacs/source-tree
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
432 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
433
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
434 (or wherever your source tree is). This will magically create symlinks and
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
435 populate your build directory.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
436
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
437 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
438 Use --site-prefixes (or --site-includes and --site-libraries) if you have
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
439 some packages that XEmacs can compile with that are located in an unusual
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
440 place. For example:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
441
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
442 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
443 --site-prefixes=/usr/local/pgsql:/usr/local/BerkeleyDB.4.1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
444 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
445
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
446 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
447 Depending on your build environment, consuder setting or not setting
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
448 options for menubars, scrollbars, window systems, native sound, etc. If
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
449 you're not sure, leave them out and let configure do the auto-detection.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
450 (If you get bugs compiling GTK, use @code{--with-gtk=no --with-gnome=no}.)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
451
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
452 Part of the configure output is a summary that looks something
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
453 like the following. (this summary is also available as the file
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
454 'Installation' in the top directory of your build tree, and via
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
455 the command @kbd{M-x describe-installation RET}).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
456
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
457 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
458 uname -a: Linux eicq 2.4.20 #1 Wed Dec 18 02:14:29 EST 2002 i586 unknown
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
459
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
460 ./configure '--extra-verbose' '--site-prefixes=/usr/local/pgsql:/usr/local/BerkeleyDB.4.1' '--dynamic=yes' '--with-gtk=no' '--with-gnome=no' '--with-toolbars' '--with-wmcommand' '--with-athena=next' '--with-menubars=lucid' '--with-scrollbars=athena' '--with-dialogs=athena' '--with-widgets=athena' '--with-gif' '--with-sound=native,noesd' '--with-site-lisp=no' '--with-site-modules' '--pdump' '--with-mule' '--with-xfs' '--debug' '--error-checking=all' '--memory-usage-stats' '--use-kkcc' '--with-clash-detection'
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
461
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
462
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
463 XEmacs 21.5-b10 "burdock" (+CVS-20030131) configured for `i586-pc-linux'.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
464
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
465
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
466 Compilation / Installation:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
467 Source code location: /usr/local/src/xemacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
468 Installation prefix: /usr/local
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
469 Additional prefixes: /usr/local/pgsql /usr/local/BerkeleyDB.4.1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
470 Operating system description file: `s/linux.h'
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
471 Machine description file: `m/intel386.h'
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
472 Compiler: gcc -Wall -Wno-switch -Winline -Wmissing-prototypes -Wsign-compare -Wundef -Wstrict-prototypes -Wshadow -Wmissing-declarations -O1 -ggdb3 -Wall -Wchar-subscripts -Wunused -Wundef -Wshadow -Wsign-compare -Wmissing-declarations -march=k6
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
473 Relocating allocator for buffers: no
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
474 GNU version of malloc: yes
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
475 - Using Doug Lea's new malloc from the GNU C Library.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
476
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
477 Window System:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
478 Compiling in support for the X window system:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
479 - X Windows headers location: /usr/X11/include
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
480 - X Windows libraries location: /usr/X11/lib
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
481 - Handling WM_COMMAND properly.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
482 Compiling in support for the Athena widget set:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
483 - Athena headers location: X11/neXtaw
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
484 - Athena library to link: neXtaw
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
485 Using Lucid menubars.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
486 Using Athena scrollbars.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
487 Using Athena dialog boxes.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
488 Using Athena native widgets.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
489
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
490 TTY:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
491 Compiling in support for ncurses.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
492 Compiling in support for GPM (General Purpose Mouse).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
493
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
494 Images:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
495 Compiling in support for GIF images (builtin).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
496 Compiling in support for XPM images.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
497 Compiling in support for PNG images.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
498 Compiling in support for JPEG images.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
499 Compiling in support for TIFF images.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
500 Compiling in support for X-Face message headers.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
501
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
502 Sound:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
503 Compiling in support for sound (native).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
504
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
505 Databases:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
506 Compiling in support for Berkeley database.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
507 Compiling in support for PostgreSQL.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
508 - Using PostgreSQL header file: libpq-fe.h
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
509 - Using PostgreSQL V7 bindings.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
510
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
511 Internationalization:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
512 Compiling in support for Mule (multi-lingual Emacs).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
513 Compiling in support for XIM (X11R5+ I18N input method).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
514 - Using raw Xlib to provide XIM support.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
515 - Using XFontSet to provide bilingual menubar.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
516
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
517 Mail:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
518 Compiling in support for "dot-locking" mail spool file locking method.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
519
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
520 Other Features:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
521 Inhibiting IPv6 canonicalization at startup.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
522 Compiling in support for dynamic shared object modules.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
523 Using the new GC algorithms.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
524 Using the new portable dumper.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
525 Compiling in support for extra debugging code.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
526 WARNING: WARNING: Compiling in support for runtime error checking.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
527 WARNING: XEmacs will run noticeably more slowly as a result.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
528 WARNING: Error checking is on by default for XEmacs beta releases.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
529 WARNING:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
530 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
531 @end enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
532
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
533
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
534 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
535 Then...
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
536
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
537 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
538 $ make > ./beta.err 2>&1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
539 $ make check > ./xemacs-make-check.err 2>&1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
540 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
541
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
542 ...and you should have a working XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
543
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
544 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
545 After you have verified that you have a functional editor, fire up
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
546 your favorite mail program and send a build report to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
547 @uref{mailto:xemacs-buildreports@@xemacs.org}.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
548
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
549 Preferably this is best done from XEmacs, following these simple steps:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
550
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
551 @enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
552 @kbd{M-x customize-group RET build-report RET}
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
553 @kbd{M-x build-report RET}
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
554 @end enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
555
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
556 See also
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
557 @uref{http://www.xemacs.org/Releases/Public-21.2/tester.html#reporting}
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
558
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
559 If you create the report manually by other means, here is what the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
560 build report should include:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
561
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
562 @enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
563 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
564 Your hardware configuration (OS version, etc.)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
565
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
566 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
567 Version numbers of software in use (X11 version, system library
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
568 versions if appropriate, graphics library versions if appropriate).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
569 If you're on a system like Linux, include all the version numbers
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
570 you can because chances are it makes a difference.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
571
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
572 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
573 The options given to configure
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
574
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
575 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
576 The configuration report illustrated above
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
577
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
578 For convenience all of the above items are placed in a file called
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
579 `Installation' in the top level build directory. They are also
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
580 available by performing @kbd{M-x describe-installation} inside XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
581
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
582 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
583 Any other unusual items you feel should be brought to the attention
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
584 of the developers.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
585 @end enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
586 @end enumerate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
587
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
588 @node Packages, Improving XEmacs, Compiling Beta XEmacs, Top
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
589 @chapter Packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
590
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
591 [Note: these instructions have been partly updated, but not carefully
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
592 reviewed in some time. Caveat tester.]
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
593
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
594 Starting with XEmacs 21.1, much of the functionality of XEmacs has
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
595 been unbundled into "the packages." For more information about the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
596 package system, see the Info nodes on Packages (in the XEmacs User
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
597 Manual) and on Packaging (in the Lisp Reference).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
598
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
599 When bootstrapping XEmacs, you may need to manually install some
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
600 packages (at least xemacs-base and efs). These packages are available
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
601 by FTP at @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/}.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
602
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
603 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
604 * Binary package installation::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
605 * Manual procedures for package management::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
606 * Building XEmacs and XEmacs packages from scratch::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
607 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
608
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
609 @node Binary package installation, Manual procedures for package management, Packages, Packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
610 @section Binary package installation
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
611
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
612 Prerequisite: XEmacs 21.0-b1.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
613
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
614 Binary packages are complete entities that can be untarred at the top
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
615 level of an XEmacs package hierarchy and work at runtime. To install files
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
616 in this directory, run the command @kbd{M-x package-admin-add-binary-package}
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
617 and fill in appropriate values to the prompts.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
618
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
619 @node Manual procedures for package management, Building XEmacs and XEmacs packages from scratch, Binary package installation, Packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
620 @section Manual procedures for package management
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
621
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
622 Prerequisite: XEmacs 21.0
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
623
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
624 When adding and deleting files from a lisp directory the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
625 auto-autoloads.el (global symbols) and custom-load.el (Customization
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
626 groups) must be kept in synch. Assuming one is manipulating a
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
627 directory called `lisp-utils', the command to rebuild the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
628 auto-autoloads.el file is:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
629
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
630 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
631 xemacs -vanilla -batch \
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
632 -eval \("setq autoload-package-name \"lisp-utils\""\) \
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
633 -f batch-update-directory lisp-utils
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
634 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
635
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
636 The command to rebuild the custom-load.el file is:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
637
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
638 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
639 xemacs -vanilla -batch -f Custom-make-dependencies lisp-utils
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
640 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
641
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
642 To byte-compile both of these files the command is:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
643
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
644 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
645 xemacs -vanilla -batch -f batch-byte-compile \
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
646 lisp-utils/auto-autoloads.el lisp-utils/custom-load.el
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
647 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
648
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
649 Of course, being a beta tester, you'd be aware that it is much easier
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
650 to manage your XEmacs packages with PUI.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
651
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
652 @node Building XEmacs and XEmacs packages from scratch, , Manual procedures for package management, Packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
653 @section Building XEmacs and XEmacs packages from scratch
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
654
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
655 To build everything completely from scratch isn't hard, just time
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
656 consuming.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
657
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
658 @subheading Step 1 - grab the sources (core and packages)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
659
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
660 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
661 $ cvs -d :pserver:cvs@@cvs.xemacs.org:/pack/xemacscvs login
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
662 [password: "cvs" (sans quotes)]
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
663
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
664 $ cvs -d :pserver:cvs@@cvs.xemacs.org:/pack/xemacscvs co -d xemacs-21.5 xemacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
665
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
666 $ cvs -d :pserver:cvs@@cvs.xemacs.org:/pack/xemacscvs co packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
667 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
668
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
669 @subheading Step 2 - build XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
670
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
671 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
672 $ cd xemacs-21.5
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
673 $ ./configure [options...]
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
674 $ make > ./beta.err 2>&1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
675 $ make check > ./xemacs-make-check.err 2>&1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
676 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
677
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
678 And optionally:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
679
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
680 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
681 $ make install > ./xemacs-make-install.err 2>&1
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
682 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
683
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
684 @subheading Step 3 - build and install the packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
685
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
686 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
687 $ cd packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
688 $ cp Local.rules.template Local.rules
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
689 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
690
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
691 Then edit Local.rules to suit your needs/environment
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
692 (@pxref{Local.rules file,,, xemacs, XEmacs User's Manual}) for details
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
693 about this file.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
694
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
695 And then:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
696
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
697 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
698 $ make install
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
699 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
700
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
701 @node Improving XEmacs, Index, Packages, Top
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
702 @chapter Improving XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
703
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
704 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
705 * Creating patches for submission::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
706 * Large contributions::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
707 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
708
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
709 @node Creating patches for submission, Large contributions, Improving XEmacs, Improving XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
710 @section Creating patches for submission
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
711
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
712 All patches to XEmacs that are seriously proposed for inclusion (eg,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
713 bug fixes) should be mailed to @uref{mailto:xemacs-patches@@xemacs.org}. Each
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
714 patch will be reviewed by the patches review board, and will be
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
715 acknowledged and added to the distribution, or rejected with an
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
716 explanation. Progress of the patch is tracked on the XEmacs Patches
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
717 mailing list, which is open subscription. (If a patch is simply
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
718 intended to facilitate discussion, "I mean something that works like
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
719 this but this is really rough", a Cc to XEmacs Patches is optional,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
720 but doesn't hurt.)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
721
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
722 Patches to XEmacs Lisp packages should be sent to the maintainer of
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
723 the package. If the maintainer is listed as `XEmacs Development Team'
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
724 patches should be sent to @uref{mailto:xemacs-patches@@xemacs.org}.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
725
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
726 Emailed patches should preferably be sent in MIME format and quoted
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
727 printable encoding (if necessary).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
728
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
729 The simplest way to create well-formed patches is to use CVS and
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
730 Didier Verna's Patcher library (available as patcher.el in the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
731 xemacs-devel package). Patcher is new and requires some setup, but
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
732 most of the core developers are now using it for their own patches.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
733 Patcher also can be configured to create patches for several projects,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
734 and recognize the project from the directory it is invoked in. This
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
735 makes it a useful general tool (as long as XEmacs-style patches are
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
736 accepted at your other projects, which is likely since they conform to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
737 the GNU standards).
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
738
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
739 When making patches by hand, please use the `-u' option, or if your
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
740 diff doesn't support it, `-c'. Using ordinary (context-free) diffs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
741 are notoriously prone to error, since line numbers tend to change when
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
742 others make changes to the same source file.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
743
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
744 An example of the `diff' usage:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
745
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
746 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
747 $ diff -u OLDFILE NEWFILE
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
748 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
749
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
750 -or-
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
751
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
752 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
753 $ diff -c OLDFILE NEWFILE
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
754 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
755
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
756 Also, it is helpful if you create the patch in the top level of the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
757 XEmacs source directory:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
758
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
759 @example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
760 $ cp -p lwlib/xlwmenu.c lwlib/xlwmenu.c.orig
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
761 hack, hack, hack....
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
762 $ diff -u lwlib/xlwmenu.c.orig lwlib/xlwmenu.c
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
763 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
764
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
765 Also note that if you cut & paste from an xterm to an XEmacs mail
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
766 buffer you will probably lose due to tab expansion. The best thing to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
767 do is to use an XEmacs shell buffer to run the diff commands, or ...
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
768 @kbd{M-x cd} to the appropriate directory, and issue the command
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
769 @kbd{C-u M-!} from within XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
770
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
771 Patches should be as single-minded as possible. Mammoth patches can
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
772 be very difficult to place into the right slot. They are much easier
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
773 to deal with when broken down into functional or conceptual chunks.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
774 The patches submitted by Kyle Jones and Hrvoje Niksic are stellar
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
775 examples of how to "Do The Right Thing".
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
776
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
777 Each patch should be accompanied by an update to the appropriate
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
778 ChangeLog file. Guidelines for writing ChangeLog entries is governed
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
779 by the GNU coding standards. Please see
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
780 @uref{http://www.gnu.org/prep/standards_toc.html} [Change Logs section]
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
781 for details.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
782
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
783 Do not submit context diffs (either -c or -u) of ChangeLogs. Because
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
784 of the "stack" nature of ChangeLogs (new entries are always pushed on
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
785 the top), context diffs will fail to apply more often than they
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
786 succeed. Simply cutting and pasting the entry from an Emacs buffer to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
787 the mail buffer (beware of tab expansion!) is probably easiest. The
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
788 Patcher library also will set up your ChangeLogs for you, and copy
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
789 them to the mail. Context-less unified diffs (-U 0) are also
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
790 acceptable.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
791
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
792 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
793 * Patch discussion etiquette::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
794 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
795
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
796 @node Patch discussion etiquette, , Creating patches for submission, Creating patches for submission
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
797 @subsection Patch discussion etiquette
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
798
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
799 If you intend a patch for _application_ to the sources as is, _always_
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
800 post it to xemacs-patches, even if there are minor points you would
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
801 like to have discussed by others. Not doing so will resulting in
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
802 patches getting "lost". If you expect that the patch will not be
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
803 acceptable, but are using it to stimulate discussion, then don't post
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
804 to xemacs-patches. Intermediate cases are up to your judgment;
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
805 unless you're sure you'll follow up with a "real" patch, better to err
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
806 on the side of posting to xemacs-patches.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
807
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
808 Discussion of the _content_ of the patch (ie responses to reviewer
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
809 comments beyond "that's right, ok, I'll do it your way") should _always_
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
810 be posted to xemacs-beta or to xemacs-design. If you're not sure
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
811 which is more appropriate, send it to xemacs-beta. That is the most
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
812 widely read channel.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
813
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
814 If discussion results in a bright idea and you come up with a new
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
815 patch, normally you should post it to both mailing lists. The people
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
816 discussing on XEmacs Beta will want to know the outcome of the thread,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
817 and you need to submit to XEmacs Patches as the "list of record."
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
818
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
819 If the old patch has been applied to CVS, then just submit the new one
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
820 as usual. If it has not been applied, then it is best to submit a new
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
821 patch against CVS. If possible do this as a reply to the original
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
822 patch post, or something following it in the thread. (The point is to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
823 get the original patch post's Message-ID in your References header.)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
824 In this case, also use the keyword SUPERSEDES in the Subject header to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
825 indicate that the old patch is no longer valid, and that this one
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
826 replaces it.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
827
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
828 These rules will result in a fair number of cross posts, but we don't
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
829 yet have a better way to handle that.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
830
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
831 Note: Developers should never post to xemacs-patches unless there is a
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
832 patch in the post. We plan to enforce this with an automatic filter.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
833
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
834 The exceptions are administrative. If you have commit authorization,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
835 then post a short COMMIT notice to xemacs-patches when you commit to
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
836 CVS. Members of the Review Board will also post short notices of
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
837 administrative action (APPROVE, VETO, QUERY, etc) to xemacs-patches.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
838
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
839 @node Large contributions, , Creating patches for submission, Improving XEmacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
840 @section Large contributions
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
841
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
842 Perhaps you have a whole new mode, or a major synchronization with
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
843 upstream for a neglected package, or a synchronization with GNU Emacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
844 you would like to contribute. We welcome such contributions, but they
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
845 are likely to be relatively controversial, generate more comments and
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
846 requests for revision, and take longer to integrate. Please be
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
847 patient with the process.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
848
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
849 @menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
850 * Updates to existing packages::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
851 * New packages::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
852 * Syncing with GNU Emacs::
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
853 @end menu
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
854
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
855 @node Updates to existing packages, New packages, Large contributions, Large contributions
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
856 @subsection Updates to existing packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
857
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
858 If a package has gotten a bit out of date, or even started to bitrot,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
859 we welcome patches to synchronize it with upstream/GNU Emacs versions.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
860 Most packages end up varying somewhat from their GNU origins. See
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
861 "Syncing with GNU Emacs" for hints. Note that if you do a reasonably
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
862 large amount of syncing with GNU Emacs, you should log this in the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
863 file itself as well as in the ChangeLog.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
864
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
865 If the package is important to you, please consider becoming the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
866 maintainer. (See "New packages", below.)
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
867
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
868 @node New packages, Syncing with GNU Emacs, Updates to existing packages, Large contributions
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
869 @subsection New packages
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
870
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
871 If you have a new mode or other large addition that does not require
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
872 changes to the core, please consider submitting it as a package, and
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
873 becoming the maintainer. You get direct commit privileges to the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
874 repository for your package, "approval" privileges for your own
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
875 patches as well as third party patches to your package, and some
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
876 degree of veto power over patches you don't like. In return, you are
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
877 expected to maintain friendly liaison with the upstream developer (if
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
878 you aren't the upstream developer), keep watch on the XEmacs Patches
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
879 list for relevant patches, and be available by email to other
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
880 developers for discussion of changes that impact your package. It's
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
881 also a pretty standard route to the "core" development group, where we
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
882 have plenty of extra work waiting for volunteers.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
883
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
884 You don't have to become the maintainer, but it virtually ensures
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
885 rapid acceptance of the package.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
886
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
887 For help in creating new packages, see the (rather sparse) discussions
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
888 in the XEmacs User's Guide and the Lisp Reference Manual. The
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
889 participants in the XEmacs Beta mailing list
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
890 @uref{mailto:xemacs-beta@@xemacs.org} and the XEmacs Package Release
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
891 Engineer are the most likely sources of advice. See
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
892 @uref{http://www.xemacs.org/Develop/jobs.html#package,jobs.html} for
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
893 current information about package release engineers.
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
894
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
895 @node Syncing with GNU Emacs, , New packages, Large contributions
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
896 @subsection Syncing with GNU Emacs
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
897
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
898 Syncing with GNU Emacs is an important activity. Although each
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
899 version has its advantages and areas of concentration, it is very
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
900 desirable that common functionality share specifications and APIs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
901 When porting GNU code to XEmacs, the following points should be given
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
902 special attention:
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
903
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
904 @itemize @bullet
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
905 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
906 Recent GNU Emacsen cannot be built without Mule, but XEmacs can.
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
907 Make sure that changes that depend on the presence of Mule are
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
908 appropriately conditionalized, with @samp{#ifdef MULE} in C code and
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
909 with @samp{(featurep 'mule)} in Lisp.
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
910
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
911 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
912 GNU Emacs nomenclature often differs from that of XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
913 Sometimes syncing the names is desirable, other times not.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
914
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
915 @item
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
916 GNU Emacs functionality often differs from that of XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
917 Syncing functionality is often controversial.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
918 @end itemize
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
919
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
920 It is important that you let other developers know that
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
921 synchronization has taken place, to what degree, and when. For this
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
922 purpose, we use comments of the form
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
923
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
924 @example
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
925 /* Synched up with: GNU 21.3 by Stephen Turnbull */
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
926 @end example
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
927
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
928 in the source file itself, as the last element of the prefatory
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
929 material (copyright notice and commentary). Obviously the comment
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
930 marker needs to be changed to leading semicolons for Lisp, but
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
931 otherwise the format is the same. (Older sync comments may have ``FSF''
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
932 in place of ``GNU''. They're equally accurate in our opinion, but
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
933 Richard Stallman and other GNU developers consider the term ``FSF
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
934 Emacs'' ``insulting''. Please use ``GNU'' in new sync comments.)
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
935
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
936 Of course you should note syncing as the purpose in the ChangeLog,
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
937 too. But entries get buried deep in the ChangeLog file, and may even
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
938 get moved to a separate ChangeLog.OLD file for rarely synched files.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
939
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
940 Rather than dates we use the version of GNU Emacs to sync to. If the
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
941 synchronization is partial, add a new comment describing what has
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
942 actually been synched, leaving the description of the last full sync
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
943 in place. At each full sync, remove all previous synchronization
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
944 comments.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
945
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
946 This applies to Lisp that we have broken out into packages, but
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
947 remains in the GNU Emacs core, as well to core Lisp in XEmacs.
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
948
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
949 @c Print the tables of contents
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
950 @contents
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
951 @c That's all
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
952
2547
a9527fcdf77f [xemacs-hg @ 2005-02-03 06:14:40 by stephent]
stephent
parents: 2537
diff changeset
953 @node Index, , Improving XEmacs, Top
2537
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
954 @unnumbered Index
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
955
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
956 @printindex cp
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
957
b7b90f750a78 [xemacs-hg @ 2005-01-31 20:08:32 by ben]
ben
parents:
diff changeset
958 @bye