From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id 6PePEk/HDWPrWAEAbAwnHQ (envelope-from ) for ; Tue, 30 Aug 2022 10:16:15 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id COyeEk/HDWPE+wAA9RJhRA (envelope-from ) for ; Tue, 30 Aug 2022 10:16:15 +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 8ABF0326E9 for ; Tue, 30 Aug 2022 10:16:14 +0200 (CEST) Received: from localhost ([::1]:57082 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oSwPt-0006Ov-Ca for larch@yhetil.org; Tue, 30 Aug 2022 04:16:13 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52750) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oSwPj-0006Oh-75 for guix-patches@gnu.org; Tue, 30 Aug 2022 04:16:05 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:44933) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oSwPi-0001Q9-Uu for guix-patches@gnu.org; Tue, 30 Aug 2022 04:16:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1oSwPi-0006PQ-HF for guix-patches@gnu.org; Tue, 30 Aug 2022 04:16:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#57280] [PATCH 0/3] Add documentation-files argument to emacs build system. Resent-From: Andrew Tropin Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Tue, 30 Aug 2022 08:16:02 +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.166184735224615 (code B ref 57280); Tue, 30 Aug 2022 08:16:02 +0000 Received: (at 57280) by debbugs.gnu.org; 30 Aug 2022 08:15:52 +0000 Received: from localhost ([127.0.0.1]:34682 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oSwPY-0006Ow-9n for submit@debbugs.gnu.org; Tue, 30 Aug 2022 04:15:52 -0400 Received: from relay9-d.mail.gandi.net ([217.70.183.199]:54413) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oSwPV-0006Og-DL for 57280@debbugs.gnu.org; Tue, 30 Aug 2022 04:15:50 -0400 Received: (Authenticated sender: andrew@trop.in) by mail.gandi.net (Postfix) with ESMTPSA id 921DAFF809; Tue, 30 Aug 2022 08:15:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=trop.in; s=gm1; t=1661847343; 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:references:references; bh=9feKESxnp9S+bEKqkS+kqxklM0jwXcBQkq29DdJvJg8=; b=HW28nJDTiriA1U1/BbzFxIeEBb9erTjyVlNNGH9bEBGheygt0hrb9kv5vyVf71qw5gliB3 Gg9Veoyc2Ye90WdP0xYaFGQefpIjyE6FKfMdidG2EIlE7SUwF/af2vq9f7PKXaeYW6jSH/ uEAQeECEA8NswhcwMDy6lSSkSf7+oYZCK1ATs1RbkcZzdh5KYfopiyKO6wci0lIg8GPi+b 8POach7VM3cfoyzE3AwdoSwJTzBxkmbu/aOnSqtNEYhGelCKH/bM+rfpkEkP7NMwNVZndp OPXo7y/KqNao9Gs9AasLAwpFiS+1UFrpU85J+RYEEGRmEECkPe9uZ9xie0M3rQ== From: Andrew Tropin In-Reply-To: <6f1b7bc2361cd375ee54abbeb1e9c4091329283b.camel@gmail.com> References: <87mtbr13dd.fsf@trop.in> <6f1b7bc2361cd375ee54abbeb1e9c4091329283b.camel@gmail.com> Date: Tue, 30 Aug 2022 11:15:37 +0300 Message-ID: <87bks22lli.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=1661847374; 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=9feKESxnp9S+bEKqkS+kqxklM0jwXcBQkq29DdJvJg8=; b=WAMIhwGRWo80YheIFpqcfGKBvcky8th+yoPYNqgVNiGVsNra6L/YgWRkys60vaxHAyGJ92 TrspObtrp+lwMUmNhtwtFpT0FmFzeDowR0SUBosred0h7mbWOVGDtyQYuyIl+SsO8dHxbi i5IrQ5U3ZB+DxyBDXqpC5x8bI3UpBnVfazYQo8e+F+4Sj6JxZ1tEVEBzKlRmv6NjTqaVoZ cLdaGaVGAJKO9jl2WIObg4kf/GWAGUHh5dHJrWecQgnh0kqflN5YLijRhpHKhQUBVvLPXh lDw3/OaOSpr2lJwmnCzSL1GQixR1FryjHhGtILCIu0ck+C/QeBnVBA7Uj0i9lw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1661847374; a=rsa-sha256; cv=none; b=aYOQFAPhjxynmIERFXC5ZviyDeaDNmoEcDcuBoSrp4MdixAZ6/qpT58i9UzsMCpUrDi7ik CrtS7j+wjFJN9IVqaEVuK17z1hnJ3Iz8g3PIFcWcsUfwH9p/IgL8+qXpe94U6AmFDTNmvn uPY4MmuM1pPr8FVvuezd9Zm3g3melrnCv70iU6FTVobS3RVXoWet97lS3rj1r8RH6gGJqF bVx/JbjkiVDP4SQqdEIoXmafE7oH6QtF5JvNvnGMIijzwT9rDB14VXLbGIRuQDv3IZ95rp HFPEyg7Bmdst6yJR0/TQ60F+osCYK0PjVr/egq47u1UdejqGxuoxJTGVOP0teQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=trop.in header.s=gm1 header.b=HW28nJDT; 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: -0.49 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=trop.in header.s=gm1 header.b=HW28nJDT; 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: 8ABF0326E9 X-Spam-Score: -0.49 X-Migadu-Scanner: scn1.migadu.com X-TUID: 1mHQwZYPpc1U --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable On 2022-08-29 18:38, Liliana Marie Prikler wrote: > Am Freitag, dem 26.08.2022 um 17:33 +0300 schrieb Andrew Tropin: > >> > > >=20 >> > Cheers >>=20 >> I went through a few popular packages and came up with conclusion >> that it's hard to make good heuristic for automatical documentation >> build: >>=20 >> 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. > Fair enough, there's probably similar issues with org etc. That said, > wouldn't the top-level info/org/whatever file share the package name? > In many cases, yes it would, but not always. magit: ("docs/magit.texi" "docs/magit-section.texi") geiser: ("doc/geiser.texi") geiser-guile: ("geiser-guile.texi") dash: ("dash.texi") orderless: ("orderless.texi") consult/cape/tempel: ("README.org") cider: ("doc/modules/ROOT/nav.adoc") all-the-icons: ("README.md") citar: ("README.org") org-roam: ("doc/org-roam.texi") debbugs: ("debbugs.texi" "debbugs-ug.texi") modus-themes: ("doc/modus-themes.org") >> 2. Adding automatic documentation build phase also means that almost >> all emacs packages will be rebuild > That's why I'm currently delaying native-comp until all other changes > to emacs-build-system are done. > >> It seems that manual approach is more precise, less intrusive and >> helps to get rid of many custom and non-uniform documentation build >> phases. > If you're going for a "manual" approach, I'd suggest instead making a > curried ((build-documentation #:texinfo-files #:texinfo-regexp ...) > #:outputs ...) so that the files can be written directly into the (add- > after ...) syntax. Do you mean to make a helper function, which can be used to generate a closure of build phase, which can be added with replace/add-after? Another idea is to make a separate functions for different documentation type: build-{texinfo,markdown,org,etc}-documentation. Also, it seems useful outside of emacs-build-system as well. In such case user will need to accomplish following steps: 1. add texinfo/pandoc/emacs-org dependency 2. use modify-phases to add (build-{texinfo,whatever}-documentation #:texinfo-files '("doc/manual.{texi,whatever}")), seems a little less convenient than simple #:documentation-files #~(list "manual.{texi,whatever}"), but also work, at least documentation will be built more uniformly for different packages. WDYT? =2D-=20 Best regards, Andrew Tropin --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEKEGaxlA4dEDH6S/6IgjSCVjB3rAFAmMNxykACgkQIgjSCVjB 3rDvzBAAh7YpdzAatG8Ja8UWyB+jDUi4jFp8hXNX6nvdI+82so9cGAkzF4d0yRhV vVOVi9JcJ9yliSdR1PiljIxvnTsZkIVe8WFWUl9RbC3FAJzdSjdtCf4I4JGs42B0 7TI9GiE4bb7mbCGR1ZEqIQ4GpFwHsIyHgnE+klz+CHx0haMczt8tuDWaQjOKtD2I yTqV+PPsXmk3SOI9xiRF1f2jPG95ICGVk+/2kLXkYLA2MjR91syXYWM3q3XG7MGO Xo5O66R4lAUqkktgb7TIG7huxghPvmlzP2IJRGths53Sfg2MkTmfUFWYew1dMSSU soAxwXurjGt9K5XYZMZDRMd0ErwvoX47C+gG4HVBoM6/sJJMYEWlfgPpu/VgcXD/ 3KDiW36l/AH3mt/EGmer5cQ7NGMleeP6igLMdfXmNVyAnjivefpWrUKUWsbyKOua 9llVbCgGdQQMkoj8qwmV5KJP84T9LGlWBQOm/r7UsI8rKnuaPi+q8ENIPfrBoRqR 33oFXOOJWXjom+ptzODJS7zo+/mM4rWZQu6vQuvqpJ1/NUXkbQSdIrFJ0Mhqo+ii YUic9X44apaPjE6X8jSvdvZkaeFL60Kqua7b6sJ06az0HTO9tER1W6LLB/NSLWAZ Rc9wKhKYzGcW/zREFJYbjzy2+hH9+LwrO6eJBvSJDowkM1Qt/k4= =tJA0 -----END PGP SIGNATURE----- --=-=-=--