annotate etc/InstallGuide @ 5146:88bd4f3ef8e4

make lrecord UID's have a separate UID space for each object, resurrect debug SOE code in extents.c -------------------- ChangeLog entries follow: -------------------- src/ChangeLog addition: 2010-03-15 Ben Wing <ben@xemacs.org> * alloc.c: * alloc.c (c_readonly): * alloc.c (deadbeef_memory): * alloc.c (make_compiled_function): * alloc.c (make_button_data): * alloc.c (make_motion_data): * alloc.c (make_process_data): * alloc.c (make_timeout_data): * alloc.c (make_magic_data): * alloc.c (make_magic_eval_data): * alloc.c (make_eval_data): * alloc.c (make_misc_user_data): * alloc.c (noseeum_make_marker): * alloc.c (ADDITIONAL_FREE_string): * alloc.c (common_init_alloc_early): * alloc.c (init_alloc_once_early): * bytecode.c (print_compiled_function): * bytecode.c (mark_compiled_function): * casetab.c: * casetab.c (print_case_table): * console.c: * console.c (print_console): * database.c (print_database): * database.c (finalize_database): * device-msw.c (sync_printer_with_devmode): * device-msw.c (print_devmode): * device-msw.c (finalize_devmode): * device.c: * device.c (print_device): * elhash.c: * elhash.c (print_hash_table): * eval.c (print_multiple_value): * eval.c (mark_multiple_value): * events.c (deinitialize_event): * events.c (print_event): * events.c (event_equal): * extents.c: * extents.c (soe_dump): * extents.c (soe_insert): * extents.c (soe_delete): * extents.c (soe_move): * extents.c (extent_fragment_update): * extents.c (print_extent_1): * extents.c (print_extent): * extents.c (vars_of_extents): * frame.c: * frame.c (print_frame): * free-hook.c: * free-hook.c (check_free): * glyphs.c: * glyphs.c (print_image_instance): * glyphs.c (print_glyph): * gui.c: * gui.c (copy_gui_item): * hash.c: * hash.c (NULL_ENTRY): * hash.c (KEYS_DIFFER_P): * keymap.c (print_keymap): * keymap.c (MARKED_SLOT): * lisp.h: * lrecord.h: * lrecord.h (LISP_OBJECT_UID): * lrecord.h (set_lheader_implementation): * lrecord.h (struct old_lcrecord_header): * lstream.c (print_lstream): * lstream.c (finalize_lstream): * marker.c (print_marker): * marker.c (marker_equal): * mc-alloc.c (visit_all_used_page_headers): * mule-charset.c: * mule-charset.c (print_charset): * objects.c (print_color_instance): * objects.c (print_font_instance): * objects.c (finalize_font_instance): * opaque.c (print_opaque): * opaque.c (print_opaque_ptr): * opaque.c (equal_opaque_ptr): * print.c (internal_object_printer): * print.c (enum printing_badness): * rangetab.c (print_range_table): * rangetab.c (range_table_equal): * specifier.c (print_specifier): * specifier.c (finalize_specifier): * symbols.c: * symbols.c (print_symbol_value_magic): * tooltalk.c: * tooltalk.c (print_tooltalk_message): * tooltalk.c (print_tooltalk_pattern): * window.c (print_window): * window.c (debug_print_window): (1) Make lrecord UID's have a separate UID space for each object. Otherwise, with 20-bit UID's, we rapidly wrap around, especially when common objects like conses and strings increment the UID value for every object created. (Originally I tried making two UID spaces, one for objects that always print readably and hence don't display the UID, and one for other objects. But certain objects like markers for which a UID is displayed are still generated rapidly enough that UID overflow is a serious issue.) This also has the advantage of making UID values smaller, hence easier to remember -- their main purpose is to make it easier to keep track of different objects of the same type when debugging code. Make sure we dump lrecord UID's so that we don't have problems with pdumped and non-dumped objects having the same UID. (2) Display UID's consistently whenever an object (a) doesn't consistently print readably (objects like cons and string, which always print readably, can't display a UID), and (b) doesn't otherwise have a unique property that makes objects of a particular type distinguishable. (E.g. buffers didn't and still don't print an ID, but the buffer name uniquely identifies the buffer.) Some types, such as event, extent, compiled-function, didn't always (or didn't ever) display an ID; others (such as marker, extent, lstream, opaque, opaque-ptr, any object using internal_object_printer()) used to display the actual machine pointer instead. (3) Rename NORMAL_LISP_OBJECT_UID to LISP_OBJECT_UID; make it work over all Lisp objects and take a Lisp object, not a struct pointer. (4) Some misc cleanups in alloc.c, elhash.c. (5) Change code in events.c that "deinitializes" an event so that it doesn't increment the event UID counter in the process. Also use deadbeef_memory() to overwrite memory instead of doing the same with custom code. In the process, make deadbeef_memory() in alloc.c always available, and delete extraneous copy in mc-alloc.c. Also capitalize all uses of 0xDEADBEEF. Similarly in elhash.c call deadbeef_memory(). (6) Resurrect "debug SOE" code in extents.c. Make it conditional on DEBUG_XEMACS and on a `debug-soe' variable, rather than on SOE_DEBUG. Make it output to stderr, not stdout. (7) Delete some custom print methods that were identical to external_object_printer().
author Ben Wing <ben@xemacs.org>
date Mon, 15 Mar 2010 16:35:38 -0500
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].