annotate etc/InstallGuide @ 5160:ab9ee10a53e4

fix various problems with allocation statistics, track overhead properly -------------------- ChangeLog entries follow: -------------------- lisp/ChangeLog addition: 2010-03-20 Ben Wing <ben@xemacs.org> * diagnose.el (show-memory-usage): * diagnose.el (show-object-memory-usage-stats): Further changes to correspond with changes in the C code; add an additional column showing the overhead used with each type, and add it into the grand total memory usage. src/ChangeLog addition: 2010-03-20 Ben Wing <ben@xemacs.org> * alloc.c: * alloc.c (init_lrecord_stats): * alloc.c (free_normal_lisp_object): * alloc.c (struct): * alloc.c (clear_lrecord_stats): * alloc.c (tick_lrecord_stats): * alloc.c (COUNT_FROB_BLOCK_USAGE): * alloc.c (COPY_INTO_LRECORD_STATS): * alloc.c (sweep_strings): * alloc.c (UNMARK_string): * alloc.c (gc_sweep_1): * alloc.c (finish_object_memory_usage_stats): * alloc.c (object_memory_usage_stats): * alloc.c (object_dead_p): * alloc.c (fixed_type_block_overhead): * alloc.c (lisp_object_storage_size): * emacs.c (main_1): * lisp.h: * lrecord.h: Export lisp_object_storage_size() and malloced_storage_size() even when not MEMORY_USAGE_STATS, to get the non-MEMORY_USAGE_STATS build to compile. Don't export fixed_type_block_overhead() any more. Some code cleanup, rearrangement, add some section headers. Clean up various bugs especially involving computation of overhead and double-counting certain usage in total_gc_usage. Add statistics computing the overhead used by all types. Don't add a special entry for string headers in the object-memory-usage-stats because it's already present as just "string". But do count the overhead used by long strings. Don't try to call the memory_usage() methods when NEW_GC because there's nowhere obvious in the sweep stage to make the calls. * marker.c (compute_buffer_marker_usage): Just use lisp_object_storage_size() rather than trying to reimplement it.
author Ben Wing <ben@xemacs.org>
date Sat, 20 Mar 2010 20:20:30 -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].