sbcl.sbcl

mirror of git://git.code.sf.net/p/sbcl/sbcl synced 2026-09-10 07:26:40 -04:00

History

Douglas Katzman e0d0a4579c Remove inapplicable documentation It was explicitly added in `60f84eda5c`, which caused me some skepticism as I saw no merit to keeping deceptive information in-tree. i.e. some of the internals are not right for SBCL (and possibly not CMUCL any more) such as: - SBCL executables don't produce three ELF files, there is no linker.sh etc. - object.tex is more wrong than right. The widetags are completely wrong; as are nearly all the descriptions of various headered object types. (functions don't contain a pointer to "next function", and they don't embed their FTYPE in the raw data portion, etc etc) - fasl.tex is sufficiently wrong as to be of little utility - the entire point of our LEB128-encoding is to remove bifurcation of all fops as it alludes to. Not to mention there's no fop-uniform-vector, fop-code-format, fop-pop-for-effect, and others. - foreign-linkage-symbols and linkage-table-data aren't the same at all. - our INFO database uses <category,kind> for the taxonomy, but CMUCL named them <class,type> and said that they are compared via STRING=. Neither is more obviously right, so this is just ridiculously confusing. - The interpreter documentation is flat-out 100% wrong as pertains to SBCL. All files files removed in this change are obsolete relative to SBCL, but to revise them in-place would be worse - anyone would wonder whether they document the current state of SBCL or CMUCL. The right fix would have been to take out dangling links from our docs - someone can still do that! - and not to add explictly incorrect text that increases the amount of stuff you have to mentally weed out when doing "git grep". Some "internals" docs are more prosasic and theoretical than detail-oriented, so it's hard to say whether they're right or wrong. (Is it wrong to postulate counterfactuals like "it would be nice if x,y,z held ..."?) I didn't know what to do with Makefile, so I removed it, as well as skeletal table-of-contents files.		2022-08-27 11:07:23 -04:00
..
cmu-user	Check in some CMU CL documentation verbatim.	2022-04-13 01:54:28 -07:00
internals	Remove inapplicable documentation	2022-08-27 11:07:23 -04:00
internals-notes	Use the other TLABs for something (trivial for now)	2022-08-14 15:44:20 -04:00
manual	take contrib blocklist into account for doc generation	2022-07-03 09:57:34 +01:00
clean.sh	Tighten up the cd-then-clean.sh idiom.	2021-03-14 19:37:32 +03:00
entities.inc	0.8.6.1:	2003-11-26 02:11:09 +00:00
FOR-CMUCL-DEVELOPERS	Remove #\! reader macro	2019-01-30 13:05:59 -05:00
GIT-FOR-SBCL-HACKERS.txt	1.0.20.29: small FIND fix & win32 build fix	2008-09-24 14:55:13 +00:00
GIT-WORKFLOW.md	A git-only SBCL workflow	2011-06-06 09:48:08 +03:00
make-doc.sh	1.0.42.51: disable split html manual building	2010-09-21 15:29:10 +00:00
PACKAGING-SBCL.txt	A git-only SBCL workflow	2011-06-06 09:48:08 +03:00
README	1.0.13.22: text tweaks	2008-01-10 15:54:04 +00:00
sbcl.1	Update random bits of text	2020-08-24 16:31:22 -04:00

README

SBCL is -- ahem! -- imperfectly documented. What can we say? Help with
documentation might not be refused.:-)

There is a Unix man page, sbcl.1.

There is a user manual in texinfo format, in doc/manual/. (In
binary distributions, the compiled-into-HTML translations are also
included.) 

Much of the documentation for supported extensions is in their Lisp
doc strings. For example, to find out how to use the SAVE-LISP-AND-DIE
function in the SB-EXT package, you can execute
  (documentation 'sb-ext:save-lisp-and-die 'function)
or
  (describe 'sb-ext:save-lisp-and-die)
in SBCL.

The user manual is incomplete, and some of its chapters are just notes
that "this is similar to chapter such-and-such of the CMU CL user
manual". The old CMU CL documentation can still be useful both for
missing chapters of the user manual and for documentation of the
internals of the system. It can be downloaded from
<ftp://sbcl.sourceforge.net/pub/sbcl/cmucl-docs.tar.bz2>.