[bug#71981,v3] services: configuration: Produce doc even if package->symbol fails.

Message ID ac592978bac3c2eba6d7df4600ce2c80acb0cc55.1746205081.git.~@wolfsden.cz
State New
Headers
Series [bug#71981,v3] services: configuration: Produce doc even if package->symbol fails. |

Commit Message

Tomas Volf May 2, 2025, 4:58 p.m. UTC
  Due to #71979 it can happen that package->symbol can return #f even for
packages that are defined in modules on the load patch and which were
previously loaded and set as a default value.

In that case we can just return (package-name val), since for the purpose of
illustrating the default value in the documentation the name should suffice.
And having (possibly) slightly misleading documentation property is still
better then `guix pull' just failing due to passing #f to symbol->string.

* gnu/services/configuration.scm (generate-documentation)[package?]: Fall back
to package-name if package->symbol fails.

Change-Id: I9987caf40d3ff62a52cbd6e3325aa42c69a6c47a
---
 gnu/services/configuration.scm | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
  

Patch

diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm
index 15eddd7665..4280f50d1f 100644
--- a/gnu/services/configuration.scm
+++ b/gnu/services/configuration.scm
@@ -446,7 +446,14 @@  (define (generate-documentation documentation documentation-name)
                    (define (show-default val)
                      (cond
                       ((package? val)
-                       (symbol->string (package->symbol val)))
+                       (let ((sym (package->symbol val)))
+                         ;; Work around for #71979.  While in the alternate
+                         ;; the answer will not always match the symbol, it
+                         ;; should be good enough for illustrating the default
+                         ;; value in documentation.
+                         (if sym
+                             (symbol->string sym)
+                             (package-name val))))
                       (((list-of package?) val)
                        (format #f "(~{~a~^ ~})" (map package->symbol val)))
                       (else (str val))))