From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id wEdnJ1TnCGMP1wAAbAwnHQ (envelope-from ) for ; Fri, 26 Aug 2022 17:31:32 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id aFV7JlTnCGNrTQAAG6o9tA (envelope-from ) for ; Fri, 26 Aug 2022 17:31:32 +0200 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 4B27C3C536 for ; Fri, 26 Aug 2022 17:31:32 +0200 (CEST) Received: from localhost ([::1]:41130 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oRbIv-00060N-GX for larch@yhetil.org; Fri, 26 Aug 2022 11:31:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:45806) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oRaPK-0005B6-Ab for guix-patches@gnu.org; Fri, 26 Aug 2022 10:34:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:36277) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oRaPJ-0007GP-Vk for guix-patches@gnu.org; Fri, 26 Aug 2022 10:34:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1oRaPJ-0005Qr-N4 for guix-patches@gnu.org; Fri, 26 Aug 2022 10:34:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#57280] [PATCH 0/3] Add documentation-files argument to emacs build system. References: <87mtc18ko9.fsf@trop.in> Resent-From: Andrew Tropin Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Fri, 26 Aug 2022 14:34:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 57280 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Liliana Marie Prikler Cc: 57280@debbugs.gnu.org Received: via spool by 57280-submit@debbugs.gnu.org id=B57280.166152441320840 (code B ref 57280); Fri, 26 Aug 2022 14:34:01 +0000 Received: (at 57280) by debbugs.gnu.org; 26 Aug 2022 14:33:33 +0000 Received: from localhost ([127.0.0.1]:54259 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oRaOq-0005Q4-Sz for submit@debbugs.gnu.org; Fri, 26 Aug 2022 10:33:33 -0400 Received: from relay4-d.mail.gandi.net ([217.70.183.196]:45465) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oRaOo-0005Pn-Jr for 57280@debbugs.gnu.org; Fri, 26 Aug 2022 10:33:31 -0400 Received: (Authenticated sender: andrew@trop.in) by mail.gandi.net (Postfix) with ESMTPSA id 4DDC3E000A; Fri, 26 Aug 2022 14:33:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=trop.in; s=gm1; t=1661524402; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to; bh=aUlJ1nFZ/7/tvRAI1ZIYgCg7Mc2xzacN79+Grvce5Mw=; b=W0fsUJWlWxu5zYSy4/YM/5nrIhph8091DEv27WNBZX2qlHzrdz3cuWC2pLmX1Qq3xEPokl vCG1Wg/Q9QOXuYD8i54/5EkdpfK0z80oyFxRABzf4sb0vG7deTT8qZSIufvJHyNR+vwbJ7 KNHKP1flS2FCKo5eKBzHMPi5HeHCWJArhigoyDWPKutvASTz8f4T938FiIjmBm5hJIwI/R y03a3fKtekmMax7aLg9R+WwriVku4cbI2Xz2b1DtP85JQb6HrQ7NxNr93JUoDQZlQWd53K raed3dwczWGQqnWhwTQvq2WOqdjIOkaYOuhTg94x/0BWWI3wKnnEVfX4nnVzFg== From: Andrew Tropin In-Reply-To: Date: Fri, 26 Aug 2022 17:33:18 +0300 Message-ID: <87mtbr13dd.fsf@trop.in> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature" X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: "Guix-patches" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1661527892; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:resent-cc:resent-from:resent-sender: resent-message-id:in-reply-to:in-reply-to:references:references: list-id:list-help:list-unsubscribe:list-subscribe:list-post: dkim-signature; bh=aUlJ1nFZ/7/tvRAI1ZIYgCg7Mc2xzacN79+Grvce5Mw=; b=qIpnu8s/NBTADe4+P+Fl4H3ktGVnEobF2gv6ZNNyO2iqudpR8fBdZOWABjJSp9eLayNXCI VEjCBF7TNWahxwaZ/0gG7ThDWU8EARnrHj/VUrx+DobwQDEZ4XZgfAAFm4ZqLPiPsynaSR iTeDeKLOPt6ojPTrkRWEx6TKtUAbHWgX6556+ek+/ndSUHst21rZ5a+BABtFzeZuS4FEG8 uD+t64vlyEPLRMnZg92qvJKliCDPvFdctuUF6r6P66P290eZ8kx1wqJlbAH/36omr+F0Hw opfD14WA+x88FvJ7IQtRBVoCwQXmL9jAwQlKFdnkBdi+oWKoYvCeoaV+jQSfgQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1661527892; a=rsa-sha256; cv=none; b=rTgluJ1sG+2vvYPon+3Zy9WnADr9yNUjaN2s/Mh2TEsf/iZSMGsc0dHAJ/ff08vNbHoq4V B3v1EqOx/566WuiWEngEZcxNU3w2N5rjbmuCxbq/klxC1jGH3XtvIC37HhzoqXCUsOD/MP Lju1VvFnPzoRHzMd9Dif5cA8zTgwPzdtgYfKXMcbjkJ81bj9bQ0Y+avUBZX722fD2MFrIC FuL28zorqOCdneYb9ui4K8r6c5kI7bSFJOVETq1p9kaalOKjUwrCPlj8Avrh6bwmkwfra7 X/OuwuUV6Uq4GCrIsCQD354J9VFkEcLhhHw4QyBsCNjlW1Wy39smAQd6ECwJJA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=trop.in header.s=gm1 header.b=W0fsUJWl; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -1.41 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=trop.in header.s=gm1 header.b=W0fsUJWl; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 4B27C3C536 X-Spam-Score: -1.41 X-Migadu-Scanner: scn0.migadu.com X-TUID: d+8oVGfLJIQ3 --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On 2022-08-19 17:39, Liliana Marie Prikler wrote: > Am Freitag, dem 19.08.2022 um 09:21 +0300 schrieb Andrew Tropin: >> On 2022-08-19 06:19, Liliana Marie Prikler wrote: >> > I think it's possible to cover most of those with heuristics.=C2=A0 For >> > the rest, we can still override the phase or just rename the file >> > to something our heuristics handle. >> >=20 >>=20 >> If there is an info file(s) do nothing. >> If there are texinfo file build them. >> If there are no texinfo files build README.org or README. >>=20 >> Something like that? >>=20 >> Will play around with it a little bit and will publish v2 next week. > I'd word those in terms of for-each, i.e. "build all texinfo files and > org-mode files". Don't trust already compiled sources, i.e. if there's > both README.info and README.org, you still want to generate README.info > from README.org (though "README" doesn't sound like a particular good > heuristic for an org-file to makeinfo from). > >> > >=20 > Cheers I went through a few popular packages and came up with conclusion that it's hard to make good heuristic for automatical documentation build: 1. I tried (find-files "." "\\.(texi|txi|texinfo)$") with consequent for-each and it doesn't work in general case because it will build files intended for inclusion, not standalone building. And it's not fixable with auxiliary build phase. Examples: geiser, dash. It seems that we need to decide manually for each package, which documentation files to build. 2. Adding automatic documentation build phase also means that almost all emacs packages will be rebuild and we don't know what documentation will be shipped (if it useful doc compiled from texinfo or almost empty README.org). It seems that manual approach is more precise, less intrusive and helps to get rid of many custom and non-uniform documentation build phases. I'll check a few more emacs packages I use and will send updated implementation of #:documentation-files argument. =2D-=20 Best regards, Andrew Tropin --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEKEGaxlA4dEDH6S/6IgjSCVjB3rAFAmMI2a4ACgkQIgjSCVjB 3rAE7w/9EMMmMVurXQE0dETQPiikNEolzL3kEWgmZG+J9smv4fm0XHYfXpbJ9b+J 0aeeOH4SbCH3cn7Zfs5lCm4D1dXQ1WGTu14C/0+yqiHESoJXhzYTvsY3enWeRlXM WSjPlPP2RGJlXGulCkBDPINUaLDCd7KHKlY/pp7KdX03WwEteMiM+Sr4r3PvB3DX 3dMmU0tte4EMjCDaSA3QKSJeay1MwJw4LAxG7wgeuiIuqQcGpYHLeJiMYc0vaqt3 poyryTCaOFU02d1iBvgt6b3fmpB7lkKsCRzhnd4u50YTc13Dx9n9ICjHWWUpmggp nssnfGCx/5OzVSAstYBwL/YS+TLNwGVr4rBia/Gvqoc5f0bCK6WrpcRvrA7JMymL mlThWzjm0s+dkYNRODRFTz9swSNZgmrm+D/iWISF+Np6aDphIXvSEOJ4KUB1g6dc /9ROAJbUMzvPGtzx4zjh4/j95pj1aIesXkFstaQ0VHFAmd1crj8mQgFNi7a54Ca1 Jm0yP5sgqfSfdWuqm06ObbgIuOqkBrkfcZg3F1N/EMGy5P8R6y5X0lehnCAkr6EH OuE0OO6M8GKJb1wjPkqOCw1T3dGrgxc9hCaalVL0/ekcYuDpoDumTXWGVgOBsN0+ Yf9rBVMxcAKIK0DYvPK+h9EpiPC+Rc8qX6906+tl6GCyFN2MkoA= =uYib -----END PGP SIGNATURE----- --=-=-=--