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 10:49:43 +0000 Message-ID: <871q8zcxfc.fsf@posteo.net> References: <87h6k4sx2o.fsf@posteo.net> <878r5gjav5.fsf@gmx.de> 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="34600"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Kjartan =?utf-8?B?w5NsaSDDgWfDunN0c3Nvbg==?= , "emacs-devel@gnu.org" , "Stefan Monnier" To: Michael Albinus Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Feb 26 11:53:50 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 1reYcH-0008kR-Uz for ged-emacs-devel@m.gmane-mx.org; Mon, 26 Feb 2024 11:53:50 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1reYYy-0002e9-30; Mon, 26 Feb 2024 05:50:25 -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 1reYYZ-0002ai-7L for emacs-devel@gnu.org; Mon, 26 Feb 2024 05:49:59 -0500 Original-Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1reYYN-0003iC-SD for emacs-devel@gnu.org; Mon, 26 Feb 2024 05:49:49 -0500 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id D462024002A for ; Mon, 26 Feb 2024 11:49:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1708944584; bh=BjexNqOxF/gmy8KKpUJzAev4qAAAVI/cWGZRQOBJ53I=; h=From:To:Cc:Subject:OpenPGP:Date:Message-ID:MIME-Version: Content-Type:From; b=nnsTfy1tjjGcJ3zSCf4samuV87bn/V/TeedvPl1o0ycNjnwF72XWJ5ZvTGzj9Fk39 riexzLBlAPNuf2q4O3wmb5WKt8Gq/kgRPf3f5vnZEhySHWR3Zds9xlru3HVdF+0wZ0 YblafZP1VMsiyv6xlzJtjzRhKqfU7hd/zBssbv1XohaKdetQlhENiLq4egdeVtI4H2 7lfOIqVwGUZsO8nynLRAQDMpizHUZWer5sp5Ve8rLH19oZ+j074yArV9hQT1yd07Hn y4GGPdJ8tcM1pNyqDidY5hxfHmpxL8KKP2tPHxm6WEXW6qAIU1b6BA7Cwvk0ShcH6j 7HsduAOWFR6ww== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Tjy6w0Zlkz9rxL; Mon, 26 Feb 2024 11:49:43 +0100 (CET) In-Reply-To: <878r5gjav5.fsf@gmx.de> (Michael Albinus's message of "Wed, 27 Dec 2023 09:41:34 +0100") OpenPGP: id=7126E1DE2F0CE35C770BED01F2C3CC513DB89F66; url="https://keys.openpgp.org/vks/v1/by-fingerprint/7126E1DE2F0CE35C770BED01F2C3CC513DB89F66"; preference=signencrypt Received-SPF: pass client-ip=185.67.36.65; envelope-from=philipk@posteo.net; helo=mout01.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.01, RCVD_IN_MSPIKE_WL=-0.01, 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:316554 Archived-At: --=-=-= Content-Type: text/plain Michael Albinus writes: > Philip Kaludercic writes: > > Hi Philip, > >> ... then the documentation should be packaged in >> the tarball and also appear online under >> https://elpa.gnu.org/packages/doc/calibre.html. > > On https://elpa.gnu.org/packages/doc/, there is a directory of all > manuals, plus the README of plz.el. The latter is wrong here, I guess. It turns out that this is actually a more general issue, since elpa-admin.el keeps the basename of the file being rendered, even if multiple packages use the same name (e.g. as is the case with packages that use "README.org"). As we want to be able to render multiple manual files, we cannot just trivially rename the name of the symlink. I think the simplest solution is to point to files in the respective doc/ sub-directory of each package: --=-=-= Content-Type: text/plain Content-Disposition: inline diff --git a/elpa-admin.el b/elpa-admin.el index cde0e3437a..3e79bef078 100644 --- a/elpa-admin.el +++ b/elpa-admin.el @@ -1856,7 +1856,11 @@ 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 (expand-file-name + (cdr doc) + (expand-file-name + (symbol-name (car pkg-spec)) + html-dir)))) (insert "" (car doc) "\n") --=-=-= Content-Type: text/plain and perhaps even stop generating the symlinks. > Best regards, Michael. -- Philip Kaludercic on peregrine --=-=-=--