From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: Manuals for GNU ELPA packages Date: Mon, 26 Feb 2024 14:05:53 +0000 Message-ID: <87o7c3b9ry.fsf@posteo.net> References: <87h6k4sx2o.fsf@posteo.net> <878r5gjav5.fsf@gmx.de> <871q8zcxfc.fsf@posteo.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="39225"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Michael Albinus , Kjartan =?utf-8?B?w5NsaSA=?= =?utf-8?B?w4Fnw7pzdHNzb24=?= , "emacs-devel@gnu.org" To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Feb 26 15:06:42 2024 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rebcw-0009ws-Cy for ged-emacs-devel@m.gmane-mx.org; Mon, 26 Feb 2024 15:06:42 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rebcG-0001FG-6d; Mon, 26 Feb 2024 09:06:00 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rebcF-0001Eq-48 for emacs-devel@gnu.org; Mon, 26 Feb 2024 09:05:59 -0500 Original-Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rebcC-0001Me-TX for emacs-devel@gnu.org; Mon, 26 Feb 2024 09:05:58 -0500 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id D8318240101 for ; Mon, 26 Feb 2024 15:05:54 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1708956354; bh=bK3wIWZAKyxT3jqBI0eOcxTNoT1WUCJ4FdMS8yZHxxo=; h=From:To:Cc:Subject:OpenPGP:Date:Message-ID:MIME-Version: Content-Type:From; b=Z/zzwxet6jVwRkrNjqpBlRdXT53t7zqFZX+QelE6v4DpXxbPa4ZTj9+RMv8U5IrU5 MxJOW/eT8xjVMmzqAEuTD2bUiP7RAt3rKCdYY/J0rabHElDZrc3xws2C/ETxtwxusd x+dAtAA9kDGWK5leSpYQU5ILnNeIJ6itoErYKfE4hVNSGfg6Xl2IxNOJyOJUCy/Z1i 2/A/cIZ16Ls/wCjJEgDyUc0/5M+QMUMKx/b+DebFhABvrwohR6sdVQRKdf5B81R5fU rf+0OwXIIMPxw/f0j8P2DjK3wiH08GUCqMx26S0dIi1fsgUK7sHTcOZW4oQKBY758P A9GnUREHRmb6w== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Tk2TF3xvXz6tx7; Mon, 26 Feb 2024 15:05:53 +0100 (CET) In-Reply-To: (Stefan Monnier's message of "Mon, 26 Feb 2024 08:04:04 -0500") OpenPGP: id=7126E1DE2F0CE35C770BED01F2C3CC513DB89F66; url="https://keys.openpgp.org/vks/v1/by-fingerprint/7126E1DE2F0CE35C770BED01F2C3CC513DB89F66"; preference=signencrypt Received-SPF: pass client-ip=185.67.36.66; envelope-from=philipk@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:316557 Archived-At: --=-=-= Content-Type: text/plain Stefan Monnier 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: --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Link-to-HTML-manuals-in-their-respective-subdirector.patch >From e999dbdc195b27ebd5699e5e756131e9b8de5fe5 Mon Sep 17 00:00:00 2001 From: Philip Kaludercic 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 "
Manual
\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 "" (car doc) "\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 --=-=-= Content-Type: text/plain -- Philip Kaludercic on peregrine --=-=-=--