sb-manual: do not document unbuilt contribs

Also, test texinfo generation on github.

.github/workflows/linux-arm.yml

@@ -29,6 +29,8 @@ jobs:
         CC: arm-linux-gnueabihf-gcc
       run: ./make.sh --xc-host='sbcl --dynamic-space-size 700MB --lose-on-corruption --disable-ldb --disable-debugger' --arch=arm
 
+    - name: build documentation
+      run: cd ./doc/manual && sh generate-texinfo.sh
     - name: test
       env:
         CC: arm-linux-gnueabihf-gcc

.github/workflows/linux-arm64.yml

@@ -47,6 +47,8 @@ jobs:
         name: sbcl-linux-binary-arm64${{ matrix.options }}
         path: sbcl-linux-binary-arm64${{ matrix.options }}
 
+    - name: build documentation
+      run: cd ./doc/manual && sh generate-texinfo.sh
     - name: test
       run: cd tests; ./run-tests.sh --slow
     - name: ansi-test

.github/workflows/linux.yml

@@ -50,6 +50,8 @@ jobs:
     - name: test-fasteval
       if: matrix.subfeatures == 'fasteval'
       run: cd tests; ./run-tests.sh --evaluator-mode interpret
+    - name: build documentation
+      run: cd ./doc/manual && sh generate-texinfo.sh
     - name: test
       run: cd tests; ./run-tests.sh --slow
     - name: ansi-test

.github/workflows/mac.yml

@@ -37,6 +37,8 @@ jobs:
       with:
         name: sbcl-mac-binary-${{ matrix.arch }}${{ matrix.options }}
         path: sbcl-mac-binary-${{ matrix.arch }}${{ matrix.options }}
+    - name: build documentation
+      run: cd ./doc/manual && sh generate-texinfo.sh
     - name: test
       run: cd tests; ./run-tests.sh --slow
     - name: ansi-test

.github/workflows/windows-arm64.yml

@@ -58,6 +58,8 @@ jobs:
       with:
         name: sbcl-windows-installer-${{ matrix.sys }}
         path: sbcl-windows-installer
+    - name: build documentation
+      run: cd ./doc/manual && sh generate-texinfo.sh
     - name: tests
       working-directory: tests
       run: ./run-tests.sh

.github/workflows/windows.yml

@@ -49,12 +49,11 @@ jobs:
       with:
         name: sbcl-windows-installer-${{ matrix.sys }}
         path: sbcl-windows-installer
+    - name: build documentation
+      run: cd ./doc/manual && sh generate-texinfo.sh
     - name: tests
       working-directory: tests
       run: ./run-tests.sh
     - name: ansi-tests
       working-directory: tests
       run: ./ansi-tests.sh
-        
-      
-    

contrib/Makefile

@@ -20,10 +20,13 @@ sb-mpfr.fasl: sb-gmp.fasl
 sb-queue.fasl: sb-concurrency.fasl
 sb-simple-streams.fasl: sb-posix.fasl sb-bsd-sockets.fasl
 sb-grovel.fasl: asdf.fasl # for building the module, not for our build
-sb-manual.fasl: sb-aclrepl.fasl sb-bsd-sockets.fasl sb-cltl2.fasl \
+
-	sb-concurrency.fasl sb-cover.fasl sb-grovel.fasl sb-introspect.fasl \
+sb_manual_module_deps = sb-aclrepl sb-bsd-sockets sb-cltl2 sb-concurrency \
-	sb-md5.fasl sb-posix.fasl sb-rotate-byte.fasl sb-queue.fasl \
+    sb-cover sb-grovel sb-introspect sb-md5 sb-posix sb-rotate-byte \
-	sb-sprof.fasl
+    sb-queue sb-sprof sb-simd sb-simple-streams
+sb_manual_unblocked_module_deps = \
+    $(filter-out $(SBCL_CONTRIB_BLOCKLIST), $(sb_manual_module_deps))
+sb-manual.fasl: $(sb_manual_unblocked_module_deps:=.fasl)
 
 # Notes:
 # 1. Invoking $(MAKE) for nested make eliminates a warning about jobserver mode.

contrib/make-contrib.lisp

@@ -152,21 +152,18 @@
                             (push c wcu-warnings)))))
           (with-compilation-unit ()
             (loop for (generated-p stem) in (flattened-sources)
-                  do (let* ((output (let ((name (if (pathnamep stem)
+             do (let ((fasl
-                                                    stem
+                        (if (string= (pathname-type stem) "fasl")
-                                                    (merge-pathnames objdir stem))))
+                            stem
-                                      (ensure-directories-exist name)
+                            (multiple-value-bind (output warnings errors)
-                                      name))
+                                (compile-file
-                            (fasl
+                                 (logicalize stem generated-p)
-                              (if (string= (pathname-type stem) "fasl")
+                                 :output-file (ensure-directories-exist
-                                  stem
+                                               (merge-pathnames stem objdir)))
-                                  (multiple-value-bind (output warnings errors)
+                              (when (or warnings errors) (sb-sys:os-exit 1))
-                                      (compile-file (logicalize stem generated-p)
+                              output))))
-                                                    :output-file output)
+                  (fasls fasl)
-                                    (when (or warnings errors) (sb-sys:os-exit 1))
+                  (load fasl)))))
-                                    output))))
-                       (fasls fasl)
-                       (load fasl)))))
         ;; Deferred warnings occur *after* exiting the W-C-U body.
         ;; See also lp#1078460 - "unknown variable" is not really ever resolved.
         (when wcu-warnings (sb-sys:os-exit 1)))

contrib/sb-manual/TODO.md

@@ -7,13 +7,8 @@
     On the positive side, this does not load extra stuff until the
     user `require`s `sb-manual`. However, then it loads all contribs.
 
-    A finer grained approach may be preferable. For example, we could
+    It shouldn't be difficult to show documtation only for actually
-    make the `manual.lisp` file part of the contrib itself. Then
+    loaded contribs.
-    people might complain about the overhead of loading/having the
-    docstrings in the image.
-
-    Alternatively, we could have `sb-bsd-sockets/manual.lisp` as a new
-    `sb-bsd-sockets-manual` module. Eh.
 
 - How to deal with repetitive package names?
 

contrib/sb-manual/doc/contrib-modules.lisp

@@ -6,15 +6,24 @@
   (see @CUSTOMIZATION-HOOKS-FOR-USERS). This section contains
   documentation (or pointers to documentation) for some of the
   contributed modules."
+  #+#.(sb-manual::package-exists-p/reader '#:sb-aclrepl)
   (@sb-aclrepl section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-concurrency)
   (@sb-concurrency section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-cover)
   (@sb-cover section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-grovel)
   (@sb-grovel section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-introspect)
   (@sb-introspect section)
   (@sb-manual section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-md5)
   (@sb-md5 section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-posix)
   (@sb-posix section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-queue)
   (@sb-queue section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-rotate-byte)
   (@sb-rotate-byte section)
-  #+(or :x86-64 :arm64)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-simd)
   (@sb-simd section))

contrib/sb-manual/doc/sbcl.lisp

@@ -7,7 +7,9 @@
       (if long
           (format nil "~D-~2,'0D-~2,'0D ~2,'0D:~2,'0D:~2,'0D"
                   year month day hour minute second)
-          (format nil "~D-~2,'0D" year month)))))
+          (format nil "~D-~2,'0D" year month))))
+  (defun package-exists-p/reader (name)
+    (if (find-package name) '(and) '(or))))
 
 (defsection @sbcl-manual (:title "SBCL Manual")
   ;; This docstring is not used in the Texinfo version (see
@@ -44,6 +46,7 @@
   (@package-locks section)
   (@threading section)
   (@timers section)
+  #+#.(sb-manual::package-exists-p/reader '#:sb-bsd-sockets)
   (@networking section)
   (@profiling section)
   (@contributed-modules section)

contrib/sb-manual/sb-manual.asd

@@ -38,8 +38,7 @@
                              (:file "../../sb-posix/manual")
                              (:file "../../sb-queue/manual")
                              (:file "../../sb-rotate-byte/manual")
-                             (:file "../../sb-simd/manual"
+                             (:file "../../sb-simd/manual")
-                              :if-feature (:or :x86-64 :arm64))
                              (:file "../../sb-simple-streams/manual")
                              (:file "deprecation")))
                (:file "late")))

doc/manual/contrib-modules.texinfo

@@ -290,7 +290,7 @@ most appropriate version based on the instruction set extensions that
 are actually available.
 
 This kind of run time instruction set dispatch is explicitly
-supported by means of the SB-SIMD-INTERNALS:INSTRUCTION-SET-CASE
+supported by means of the @code{sb-simd-internals:instruction-set-case}
 macro. The code resulting from an invocation of this macro compiles
 to an efficient jump table whose index is recomputed on each startup
 of the Lisp image.