annotate etc/InstallGuide @ 617:af57a77cbc92

[xemacs-hg @ 2001-06-18 07:09:50 by ben] --------------------------------------------------------------- DOCUMENTATION FIXES: --------------------------------------------------------------- eval.c: Correct documentation. elhash.c: Doc correction. --------------------------------------------------------------- LISP OBJECT CLEANUP: --------------------------------------------------------------- bytecode.h, buffer.h, casetab.h, chartab.h, console-msw.h, console.h, database.c, device.h, eldap.h, elhash.h, events.h, extents.h, faces.h, file-coding.h, frame.h, glyphs.h, gui-x.h, gui.h, keymap.h, lisp-disunion.h, lisp-union.h, lisp.h, lrecord.h, lstream.h, mule-charset.h, objects.h, opaque.h, postgresql.h, process.h, rangetab.h, specifier.h, toolbar.h, tooltalk.h, ui-gtk.h: Add wrap_* to all objects (it was already there for a few of them) -- an expression to encapsulate a pointer into a Lisp object, rather than the inconvenient XSET*. "wrap" was chosen because "make" as in make_int(), make_char() is not appropriate. (It implies allocation. The issue does not exist for ints and chars because they are not allocated.) Full error checking has been added to these expressions. When used without error checking, non-union build, use of these expressions will incur no loss of efficiency. (In fact, XSET* is now defined in terms of wrap_* in a non-union build.) In a union build, you will also get no loss of efficiency provided that you have a decent optimizing compiler, and a compiler that either understands inlines or automatically inlines those particular functions. (And since people don't normally do their production builds on union, it doesn't matter.) Update the sample Lisp object definition in lrecord.h accordingly. dumper.c: Fix places in dumper that referenced wrap_object to reference its new name, wrap_pointer_1. buffer.c, bufslots.h, conslots.h, console.c, console.h, devslots.h, device.c, device.h, frame.c, frame.h, frameslots.h, window.c, window.h, winslots.h: -- Extract out the Lisp objects of `struct device' into devslots.h, just like for the other structures. -- Extract out the remaining (not copied into the window config) Lisp objects in `struct window' into winslots.h; use different macros (WINDOW_SLOT vs. WINDOW_SAVED_SLOT) to differentiate them. -- Eliminate the `dead' flag of `struct frame', since it duplicates information already available in `framemeths', and fix FRAME_LIVE_P accordingly. (Devices and consoles already work this way.) -- In *slots.h, switch to system where MARKED_SLOT is automatically undef'd at the end of the file. (Follows what winslots.h already does.) -- Update the comments at the beginning of *slots.h to be accurate. -- When making any of the above objects dead, zero it out entirely and reset all Lisp object slots to Qnil. (We were already doing this somewhat, but not consistently.) This (1) Eliminates the possibility of extra objects hanging around that ought to be GC'd, (2) Causes an immediate crash if anyone tries to access a structure in one of these objects, (3) Ensures consistent behavior wrt dead objects. dialog-msw.c: Use internal_object_printer, since this object should not escape. --------------------------------------------------------------- FIXING A CRASH THAT I HIT ONCE (AND A RELATED BAD BEHAVIOR): --------------------------------------------------------------- eval.c: Fix up some comments about the FSF implementation. Fix two nasty bugs: (1) condition_case_unwind frees the conses sitting in the catch->tag slot too quickly, resulting in a crash that I hit. (2) catches need to be unwound one at a time when calling unwind-protect code, rather than all at once at the end; otherwise, incorrect behavior can result. (A comment shows exactly how.) backtrace.h: Improve comment about FSF differences in the handler stack. --------------------------------------------------------------- FIXING A CRASH THAT I REPEATEDLY HIT WHEN USING THE MOUSE WHEEL UNDER MSWINDOWS: --------------------------------------------------------------- Basic idea: My crash is due either to a dead, non-marked, GC-collected frame inside of a window mirror, or a prematurely freed window mirror. We need to mark the Lisp objects inside of window mirrors. Tracking the lifespan of window mirrors and scrollbar instances is extremely hard, and there may well be lurking bugs where such objects are freed too soon. The only safe way to fix these problems (and it fixes both problems at once) is to make both of these structures Lisp objects. lrecord.h, emacs.c, inline.c, scrollbar-gtk.c, scrollbar-msw.c, scrollbar-x.c, scrollbar.c, scrollbar.h, symsinit.h: Make scrollbar instances actual Lisp objects. Mark the window mirrors in them. inline.c needs to know about scrollbar.h now. Record the new type in lrecord.h. Fix up scrollbar-*.c appropriately. Create a hash table in scrollbar-msw.c so that the scrollbar instances stored in scrollbar HWND's are properly GC-protected. Create complex_vars_of_scrollbar_mswindows() to create the hash table at startup, and call it from emacs.c. Don't store the scrollbar instance as a property of the GTK scrollbar, as it's not used and if we did this, we'd have to separately GC-protect it in a hash table, like in MS Windows. lrecord.h, frame.h, frame.c, frameslots.h, redisplay.c, window.c, window.h: Move mark_window_mirror from redisplay.c to window.c. Make window mirrors actual Lisp objects. Tell lrecord.h about them. Change the window mirror member of struct frame from a pointer to a Lisp object, and add XWINDOW_MIRROR in appropriate places. Mark the scrollbar instances in the window mirror. redisplay.c, redisplay.h, alloc.c: Delete mark_redisplay. Don't call mark_redisplay. We now mark frame-specific structures in mark_frame. NOTE: I also deleted an extremely questionable call to update_frame_window_mirrors(). It was extremely questionable before, and now totally impossible, since it will create Lisp objects during redisplay. frame.c: Mark the scrollbar instances, which are now Lisp objects. Call mark_gutter() here, not in mark_redisplay(). gutter.c: Update comments about correct marking. --------------------------------------------------------------- ISSUES BROUGHT UP BY MARTIN: --------------------------------------------------------------- buffer.h: Put back these macros the way Steve T and I think they ought to be. I already explained in a previous changelog entry why I think these macros should be the way I'd defined them. Once again: We fix these macros so they don't care about the type of their lvalues. The non-C-string equivalents of these already function in the same way, and it's correct because it should be OK to pass in a CBufbyte *, a BufByte *, a Char_Binary *, an UChar_Binary *, etc. The whole reason for these different types is to work around errors caused by signed-vs-unsigned non-matching types. Any possible error that might be caught in a DFC macro would also be caught wherever the argument is used elsewhere. So creating multiple macro versions would add no useful error-checking and just further complicate an already complicated area. As for Martin's "ANSI aliasing" bug, XEmacs is not ANSI-aliasing clean and probably never will be. Unless the board agrees to change XEmacs in this way (and we really don't want to go down that road), this is not a bug. sound.h: Undo Martin's type change. signal.c: Fix problem identified by Martin with Linux and g++ due to non-standard declaration of setitimer(). systime.h: Update the docs for "qxe_" to point out why making the encapsulation explicit is always the right way to go. (setitimer() itself serves as an example.) For 21.4: update-elc-2.el: Correct misplaced parentheses, making lisp/mule not get recompiled.
author ben
date Mon, 18 Jun 2001 07:10:32 +0000
parents 9ad43877534d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
179
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
1 Introduction
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
2
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
3 Thank you for downloading XEmacs. We of the XEmacs development team
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
4 believe user satisfaction is our number one priority, and we hope that
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
5 you will be pleased with the power of our editor. Please follow all
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
6 of the instructions in order to enjoy a quick and easy installation.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
7
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
8
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
9 Getting Started
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
10
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
11 In this guide, information which you will need to supply will be enclosed in
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
12 angle brackets, <like this>. Commands which you will have to enter will be
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
13 indented,
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
14
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
15 like this.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
16
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
17 You will need to provide a loading directory, in which to load the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
18 material from tape (/tmp/xemacs is recommended), and a permanent
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
19 installation directory (/usr/local/xemacs is recommended).
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
20
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
21
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
22 Loading From Tape
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
23
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
24 First create and change directory to the loading directory:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
25
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
26 mkdir <working directory>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
27 cd <working directory>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
28
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
29 Now you are ready to load the software from tape.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
30
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
31 The specific device name needed to load the tape varies with hardware vendors,
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
32 and may be found in Appendix A, "Vendors and Device Names".
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
33
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
34 Load the software from tape:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
35
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
36 tar xvf /dev/<device name>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
37
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
38 You have now loaded all of the software from tape, and are ready to compile and
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
39 install the XEmacs Text Editor.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
40
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
41
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
42 Compiling and Installing the XEmacs Editor
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
43
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
44 Compiling and installing the libraries is handled by a user-friendly shell
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
45 script. You will need to provide some information to the script, such as your
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
46 organization name and registration number. To run the script, type
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
47
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
48 /bin/sh xemacs/xemacs.install -d <installation directory>
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
49
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
50 Follow the script's directions, and provide the information which it prompts
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
51 for.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
52
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
53 When the script prompts you for the directory in which the distribution files
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
54 are located, you will find that you are unable to provide it with any directory
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
55 which the script will deem satisfactory. That is because it is necessary to
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
56 order the following additional parts which are necessary to continue with the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
57 installation:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
58
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
59 Part Number Qty Name Price
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
60
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
61 GM-96-3026 1 Goat, male 1000.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
62 CB-13-2395 1 Candle, black 50.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
63 CG-63-6376 1 Chalk dust container 10.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
64 IB-89-3335 5 Incense sticks 5.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
65 DE-44-8846 1 Dagger, ebon, curved 500.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
66 AS-87-2319 1 Altar, silver 10000.00
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
67
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
68 Wait until the additional parts arrive; you will be ready to continue the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
69 installation the next Friday the 13th at midnight.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
70
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
71
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
72 Ritual for Successfully Completing Installation
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
73
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
74 Stand in front of the computer. Pour out the chalk dust in an inscribed
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
75 pentagram around you; be sure that it is without breaks. Set an incense stick
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
76 at each of the five corners, the altar in front of the computer, and the candle
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
77 in front of the altar.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
78
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
79 Light each of the incense sticks and the candles, chanting in a low voice:
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
80
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
81 Daemons and spirits of the netherworld
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
82 Forces of all that is chaotic and mysterious
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
83 Essence of Netscape and MicroSoft
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
84
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
85 I am coming here to appease you
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
86 I offer you this goat
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
87 That my software may work
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
88
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
89 I bind you here
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
90 Do not make my system crash
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
91 Let the software install as advertised
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
92
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
93 Place the goat on the altar, and slaughter it with the dagger.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
94
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
95 May this goat feed you
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
96 Sate your lust for blood
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
97 Into it may your mischief fly
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
98 Not my computer
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
99 Make the software work
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
100 For this is the only way
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
101
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
102 Then spit into the computer's ventilation slots. This will complete different
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
103 circuits inside the computer, causing its motherboard and cards to function in
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
104 ways that the engineers never intended, thereby making your system compatible
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
105 with our libraries.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
106
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
107 Reboot your computer. The installation is now complete.
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
108
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
109 [This has undergone a minor rewrite for XEmacs. It originally
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
110 appeared on rec.humor.funny courtesy of jonathan seth hayward
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
111 <jhayward@students.uiuc.edu>, and is included by permission of the
9ad43877534d Import from CVS: tag r20-3b16
cvs
parents:
diff changeset
112 author].