master: sb-manual: add links from/to PAX world
melisgl via Sbcl-commits <[email protected]> Mon, 29 Jun 2026 12:20:31 +0000
| Newsgroups | gmane.lisp.steel-bank.cvs |
|---|---|
| Message-ID | <[email protected]> |
The branch "master" has been updated in SBCL:
via ab6fa917964ce12db804b746ccba8ad7a9067e05 (commit)
from 34812e52a1d77953d118733eb3c51da37ba08ae1 (commit)
- Log -----------------------------------------------------------------
commit ab6fa917964ce12db804b746ccba8ad7a9067e05
Author: Gabor Melis <[email protected]>
Date: Sat Jun 27 09:25:36 2026 +0200
sb-manual: add links from/to PAX world
---
contrib/sb-manual/doc/sbcl.lisp | 19 ++++++++++++++-----
contrib/sb-manual/pax.lisp | 8 +++++++-
doc/manual/backmatter.texinfo | 4 ++++
3 files changed, 25 insertions(+), 6 deletions(-)
diff --git a/contrib/sb-manual/doc/sbcl.lisp b/contrib/sb-manual/doc/sbcl.lisp
index e1eb9c741..b650df104 100644
--- a/contrib/sb-manual/doc/sbcl.lisp
+++ b/contrib/sb-manual/doc/sbcl.lisp
@@ -1,13 +1,22 @@
(in-package :sb-manual)
(defsection @sbcl-manual (:title "SBCL Manual")
- #.(format nil "This manual – for SBCL version `~A`, generated _~A_ –
- is part of the SBCL software system. See the `\\\\README` file for
- more information.
+ ;; This docstring is not used in the Texinfo version (see
+ ;; EMIT-TEXINFO-FOR-SECTION).
+ #.(format nil "This is an unofficial rendering of the SBCL Manual
+ using [MGL-PAX][pax::@pax-manual] with the same content as the
+ official version at <https://www.sbcl.org/> but with heavy linking
+ internally, to the CLHS, and to the source code on
+ [GitHub](https://github.com/sbcl/sbcl).
- This manual is largely derived from the manual for the CMUCL system,
+ The output is for SBCL version `~A`, generated _~A_. See
+ <https://fixnum.com> for this document in other formats.
+
+ This manual is part of the SBCL software system. See the
+ `\\\\README` file for more information. The manual is largely
+ derived from the manual for the [CMUCL](https://cmucl.org/) system,
which was produced at Carnegie Mellon University and later released
- into the public domain. This manual is in the public domain and is
+ into the public domain. The manual is in the public domain and is
provided with absolutely no warranty. See the `\\\\COPYING` and
`\\\\CREDITS` files for more information."
(lisp-implementation-version)
diff --git a/contrib/sb-manual/pax.lisp b/contrib/sb-manual/pax.lisp
index 441bf8fad..6c527240d 100644
--- a/contrib/sb-manual/pax.lisp
+++ b/contrib/sb-manual/pax.lisp
@@ -10,7 +10,13 @@
;;;;
;;;; When PAX is loaded, we have PAX::@BROWSING-LIVE-DOCUMENTATION for
;;;; low-latency, interactive documentation work and
-;;;; PAX::@GENERATING-DOCUMENTATION for autolinked documentation.
+;;;; PAX::@GENERATING-DOCUMENTATION for autolinked documentation
+;;;; (also, see make-pax-docs.sh and http://fixnum.com).
+;;;;
+;;;; For browsing, use this setup:
+;;;;
+;;;; (setq pax:*document-downcase-uppercase-code* t
+;;;; pax:*browse-context* :pax-world)
(in-package :sb-manual)
diff --git a/doc/manual/backmatter.texinfo b/doc/manual/backmatter.texinfo
index 89551b322..06b97ac51 100644
--- a/doc/manual/backmatter.texinfo
+++ b/doc/manual/backmatter.texinfo
@@ -39,6 +39,10 @@ in one of these, that's fine, but if you want to @emph{modify} this
manual, you are strongly advised to seek the sources (most live under
@file{contrib/sb-manual/doc/}) and submit a patch.
+Also, see @url{https://fixnum.com/} for the unoffical, PAX-generated
+version with a lot more links, default values of arguments, and the
+initial values of variables.
+
@ifinfo
When viewing Info in Emacs, the reader inserts superfluous ``see''
words before internal links. Use @code{(setq Info-hide-note-references
-----------------------------------------------------------------------
hooks/post-receive
--
SBCL
_______________________________________________
Sbcl-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/sbcl-commits