Re: Manuals for GNU ELPA packages

[Philip Kaludercic <philipk@posteo.net>]

[-- Attachment #1: Type: text/plain, Size: 611 bytes --]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> -	(let ((html-file (concat html-dir (cdr doc))))
>> +	(let ((html-file (expand-file-name
>> +                          (cdr doc)
>> +                          (expand-file-name
>> +                           (symbol-name (car pkg-spec))
>> +                           html-dir))))
>
> That looks about right, except we want relative names, so we should use
> `concat` or `file-name-concat`.

Of course, I forgot that fine-name-concat was available, and yes, the
absolute file names wouldn't really improve the website experience ^^

This is my suggestion:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Link-to-HTML-manuals-in-their-respective-subdirector.patch --]
[-- Type: text/x-patch, Size: 1972 bytes --]

From e999dbdc195b27ebd5699e5e756131e9b8de5fe5 Mon Sep 17 00:00:00 2001
From: Philip Kaludercic <philipk@posteo.net>
Date: Mon, 26 Feb 2024 15:03:43 +0100
Subject: [PATCH] Link to HTML manuals in their respective subdirectories

* elpa-admin.el (elpaa--html-insert-docs): To avoid manuals with the
same names overwriting each other, link directly to the files under
doc/[package name].
(elpaa--html-build-doc): Do not generate symlinks to the actual manual
files.
---
 elpa-admin.el | 14 +++++---------
 1 file changed, 5 insertions(+), 9 deletions(-)

diff --git a/elpa-admin.el b/elpa-admin.el
index cde0e3437a..4eb47d6856 100644
--- a/elpa-admin.el
+++ b/elpa-admin.el
@@ -1856,7 +1856,10 @@ arbitrary code."
                (file-readable-p html-dir)) ;; html doc files were built
       (insert "<dt>Manual</dt> <dd>\n")
       (dolist (doc docfiles)
-	(let ((html-file (concat html-dir (cdr doc))))
+	(let ((html-file (file-name-concat
+                          html-dir
+                          (symbol-name (car pkg-spec))
+                          (cdr doc))))
 	  (insert "<a href=\"" html-file "\">"
 	          (car doc)
 	          "</a>\n")
@@ -2539,14 +2542,7 @@ directory; one of archive, archive-devel."
                :internal--html-docs
                (cons (cons (file-name-base html-file)
                            (file-name-nondirectory html-file))
-                     (plist-get (cdr pkg-spec) :internal--html-docs)))
-
-    ;; Create a symlink from elpa/archive[-devel]/doc/* to
-    ;; the actual file, so html references work.
-    (with-demoted-errors "%S" ;; 'make-symbolic-link' doesn't work on Windows
-      (make-symbolic-link
-       (concat (file-name-nondirectory html-dir) "/" destname)
-       html-xref-file t))))
+                     (plist-get (cdr pkg-spec) :internal--html-docs)))))
 
 (defun elpaa--build-Info-1 (pkg-spec docfile dir html-dir)
   "Build an info file from DOCFILE (a texinfo source file).
-- 
2.43.2


[-- Attachment #3: Type: text/plain, Size: 38 bytes --]



-- 
	Philip Kaludercic on peregrine