view lisp/README @ 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 2cf5d151eeb9
children
line wrap: on
line source

The files in this directory contain source code for the core XEmacs
facilities written in Emacs Lisp.  *.el files are Elisp source, and
*.elc files are byte-compiled versions of the corresponding *.el
files.  Byte-compiled files are architecture-independent.

Functions used only by files in this directory are considered
"internal" and are subject to change at any time.  All commands, and
most functions with docstrings, are part of the exported API.  In
particular, it is considered good style to use the Common Lisp
facilities provided in cl*.el.  (Yes, that's ambiguous.  Sorry, we
don't have a full specification of the API, as the Lispref is
chronically incomplete.  Anything described in the Lispref is part of
the API, of course.)

Libraries which implement applications and enhancements are placed in
the "packages", which are distributed separately from the core
sources.

#### Someone please update this.
#### Partially updated 2001-08-25 by sjt.  Needs more work.  Mike?

When XEmacs starts up, it adds certain directories in various
hierarchies containing Lisp libraries to `load-path' (the list of
directories to be searched when loading files).  These are: this
directory, its subdirectory ./mule (in Mule-enabled XEmacs only), the
site-lisp directory (deprecated), and all the lisp/PACKAGE
subdirectories of the xemacs-packages, mule-packages, and
site-packages hierarchies.  See setup-paths.el.

#### Is the following true or relevant any more?
bogus> Directories whose names begin with "-" or "." are not added to
bogus> the default load-path.

Some files which you might reasonably want to alter when installing or
customizing XEmacs at your site are:

	paths.el	You may need to change the default pathnames here,
			but probably not.  This is loaded before XEmacs is
			dumped.

	site-init.el	#### obsolete and removed?
			To pre-load additional libraries into XEmacs and dump
			them in the executable, load them from this file.
			Read the instructions in this file for a description
			of how to do this.

	site-load.el	#### description is obsolete
			This is like site-init.el, but if you want the 
			docstrings of your preloaded libraries to be kept in
			the DOC file instead of in the executable, you should
			load them from this file instead.  To do this, you must
			also cause them to be scanned when the DOC file is
			generated by editing ../src/Makefile.in.in and
			rerunning configure.
			#### new semantics
			This file will preload additional libraries listed in
			../site-packages and dump them into XEmacs.

	../site-packages  List of additional libraries read by site-load.el.

	site-start.el	This is loaded each time XEmacs starts up, before the
			user's .emacs file.  (Sysadmin must create.)  Can be
			inhibited for a given invocation with `--no-site-file'.

	default.el	This is loaded each time XEmacs starts up, after the
			user's .emacs file, unless .emacs sets the variable
			inhibit-default-init to t.  (Sysadmin must create.)
			Can be inhibited for a given invocation with `-q'.

	version.el	This contains the version information for XEmacs.

========================================================================
Original text follows:

The files in this directory contain source code for the XEmacs
facilities written in Emacs Lisp.  *.el files are Elisp source, and
*.elc files are byte-compiled versions of the corresponding *.el
files.  Byte-compiled files are architecture-independent.

#### Someone please update this.

bogus> When XEmacs starts up, it adds all subdirectories of the
bogus> site-lisp directory.  The site-lisp directory normally exists
bogus> only in installation trees.  For more information about the
bogus> site-lisp directory see the NEWS file.

bogus> After XEmacs adds all subdirectories of the site-lisp
bogus> directory, it adds all subdirectories of this directory to the
bogus> load-path (the list of directories to be searched when loading
bogus> files.)  To speed up this process, this directory has been
bogus> rearranged to have very few files at the top-level, so that
bogus> emacs doesn't have to stat() several hundred files to find the
bogus> dozen or so which are actually subdirectories.

bogus> Directories whose names begin with "-" or "." are not added to
bogus> the default load-path.

The only files which remain at top-level are those which you might
reasonably want to alter when installing or customizing XEmacs at your
site.  The files which may appear at top level are:

	paths.el	You may need to change the default pathnames here,
			but probably not.  This is loaded before XEmacs is
			dumped.

	site-init.el	To pre-load additional libraries into XEmacs and dump
			them in the executable, load them from this file.
			Read the instructions in this file for a description
			of how to do this.

	site-load.el	This is like site-init.el, but if you want the 
			docstrings of your preloaded libraries to be kept in
			the DOC file instead of in the executable, you should
			load them from this file instead.  To do this, you must
			also cause them to be scanned when the DOC file is
			generated by editing ../src/Makefile.in.in and
			rerunning configure.

	site-start.el	This is loaded each time XEmacs starts up, before the
			user's .emacs file.

	default.el	This is loaded each time XEmacs starts up, after the
			user's .emacs file, unless .emacs sets the variable
			inhibit-default-init to t.

	version.el	This contains the version information for XEmacs.