annotate info/dir @ 1292:f3437b56874d

[xemacs-hg @ 2003-02-13 09:57:04 by ben] profile updates profile.c: Major reworking. Keep track of new information -- total function timing (includes descendants), GC usage, total GC usage (includes descendants). New functions to be called appropriately from eval.c, alloc.c to keep track of this information. Keep track of when we're actually in a function vs. in its profile, for more accurate timing counts. Track profile overhead separately. Create new mechanism for specifying "internal sections" that are tracked just like regular Lisp functions and even appear in the backtrace if `backtrace-with-internal-sections' is non-nil (t by default for error-checking builds). Add some KKCC information for the straight (non-Elisp) hash table used by profile, which contains Lisp objects in its keys -- but not used yet. Remove old ad-hoc methods for tracking garbage collection, redisplay (which was incorrect anyway when Lisp was called within these sections). Don't record any tick info when blocking under MS Windows, since the timer there is in real time rather than in process time. Make `start-profiling', `stop-profiling' interactive. Be consistent wrt. recursive functions and functions currently on the stack when starting or stopping -- together these make implementing the `total' values extremely difficult. When we start profiling, we act as if we just entered all the functions currently on the stack. Likewise when exiting. Create vars in_profile for tracking time spent inside of profiling, and profiling_lock for setting exclusive access to the main hash table when reading from it or modifying it. (protects against getting screwed up by the signal handle going off at the same time. profile.h: New file. Create macros for declaring internal profiling sections. lisp.h: Move profile-related stuff to profile.h. alloc.c: Keep track of total consing, for profile. Tell profile when we are consing. Use new profile-section method for noting garbage-collection. alloc.c: Abort if we attempt to call the allocator reentrantly. backtrace.h, eval.c: Add info for use by profile in the backtrace frame and transfer PUSH_BACKTRACE/POP_BACKTRACE from eval.c, for use with profile. elhash.c: Author comment. eval.c, lisp.h: New Lisp var `backtrace-with-internal-sections'. Set to t when error-checking is on. eval.c: When unwinding, eval.c: Report to profile when we are about-to-call and just-called wrt. a function. alloc.c, eval.c: Allow for "fake" backtrace frames, for internal sections (used by profile and `backtrace-with-internal-sections'. event-Xt.c, event-gtk.c, event-msw.c, event-tty.c: Record when we are actually blocking on an event, for profile's sake. event-stream.c: Record internal profiling sections for getting, dispatching events. extents.c: Record internal profiling sections for map_extents. hash.c, hash.h: Add pregrow_hash_table_if_necessary(). (Used in profile code since the signal handler is the main grower but can't allow a realloc(). We make sure, at critical points, that the table is large enough.) lread.c: Create internal profiling sections for `load' (which may be triggered internally by autoload, etc.). redisplay.c: Remove old profile_redisplay_flag. Use new macros to declare internal profiling section for redisplay. text.c: Use new macros to declare internal profiling sections for char-byte conversion and internal-external conversion. SEMI-UNRELATED CHANGES: ----------------------- text.c: Update the long comments.
author ben
date Thu, 13 Feb 2003 09:57:08 +0000
parents f5d8712231af
children c2580215c222
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 -*- Text -*-
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 This is the file .../info/dir, which contains the topmost node of the Info
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 hierarchy. The first time you invoke Info you start off looking at that node,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 which is (dir)Top.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 Rather than adding new nodes to this directory (and this file) it is a better
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 idea to put them in a site-local directory, and then configure info to search
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 in that directory as well. That way, you won't have to re-edit this file when
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 a new release of the editor comes out.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 For example, you could add this code to .../lisp/site-start.el, which is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 loaded before ~/.emacs each time the editor starts up:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 ;; find local info nodes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 (setq Info-directory-list
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 (append Info-directory-list '("/private/info/")))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 Then, when you enter info, a dir file like this one will be automatically
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 created and saved (provided you have write access to the directory). The
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 contents of that file "/private/info/dir" will be appended to the contents of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 this file.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 File: dir Node: Top This is the top of the INFO tree
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 This is Info, the online documentation browsing system.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 This page (the Directory node) gives a menu of major topics.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29
1092
f5d8712231af [xemacs-hg @ 2002-11-11 14:19:07 by stephent]
stephent
parents: 721
diff changeset
30 button2 on a highlighted word follows that cross-reference.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 button3 anywhere brings up a menu of commands.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 ? lists additional keyboard commands.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 h invokes the Info tutorial.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 * Menu:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36
697
7a42cc017e59 [xemacs-hg @ 2001-12-16 10:26:55 by adrian]
adrian
parents: 462
diff changeset
37 XEmacs 21.5
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 ===========
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
39 * XEmacs:: XEmacs User's Manual.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
40 * Lispref:: XEmacs Lisp Reference Manual.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
41 * New-Users-Guide:: Getting Started with XEmacs.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
42 * XEmacs-FAQ:: XEmacs Frequently Asked Questions for 21.4.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
43 * Info:: Guide to Info, the XEmacs online documentation system.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
44 * Internals:: Guide to the internals of XEmacs.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
46 Other Documentation:
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
48 * CL:: A Common Lisp compatibility package for Emacs-Lisp.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
49 * Custom:: Customization Library for Emacs.
721
f72a191f8ecf [xemacs-hg @ 2002-01-02 20:56:32 by adrian]
adrian
parents: 697
diff changeset
50 * Emodules:: XEmacs dynamically loadable module support.
462
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
51 * External-Widget:: Use XEmacs as a text widget inside of another program.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
52 * Standards:: GNU coding standards.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
53 * Term:: A mode to control inferior processes (a comint replacement)
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
54 * Termcap:: The termcap library, which enables application programs
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
55 to handle all types of character-display terminals.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
56 * Texinfo:: The GNU documentation format.
0784d089fdc9 Import from CVS: tag r21-2-46
cvs
parents: 428
diff changeset
57 * Widget:: An Emacs Lisp widget library.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58