From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jonas Bernoulli Newsgroups: gmane.emacs.bugs Subject: bug#45435: Additional libraries required by transient and magit manuals Date: Fri, 25 Dec 2020 20:51:20 +0100 Message-ID: <87r1nd8y13.fsf@bernoul.li> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33525"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Stefan Monnier To: 45435@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Dec 25 20:52:37 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1kst8e-0008c4-K9 for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 25 Dec 2020 20:52:36 +0100 Original-Received: from localhost ([::1]:47250 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kst8d-0006Wh-0l for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 25 Dec 2020 14:52:35 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34110) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kst87-0006Wa-2b for bug-gnu-emacs@gnu.org; Fri, 25 Dec 2020 14:52:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:46622) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kst86-000452-RE for bug-gnu-emacs@gnu.org; Fri, 25 Dec 2020 14:52:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kst86-0006iR-P5; Fri, 25 Dec 2020 14:52:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jonas Bernoulli Original-Sender: "Debbugs-submit" Resent-CC: monnier@iro.umontreal.ca, bug-gnu-emacs@gnu.org Resent-Date: Fri, 25 Dec 2020 19:52:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 45435 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org X-Debbugs-Original-Xcc: Stefan Monnier Original-Received: via spool by submit@debbugs.gnu.org id=B.160892589125773 (code B ref -1); Fri, 25 Dec 2020 19:52:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 25 Dec 2020 19:51:31 +0000 Original-Received: from localhost ([127.0.0.1]:58168 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kst7b-0006hd-Ey for submit@debbugs.gnu.org; Fri, 25 Dec 2020 14:51:31 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:41398) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kst7Y-0006hV-S5 for submit@debbugs.gnu.org; Fri, 25 Dec 2020 14:51:29 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34082) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kst7X-0006WC-RA for bug-gnu-emacs@gnu.org; Fri, 25 Dec 2020 14:51:28 -0500 Original-Received: from mail.hostpark.net ([212.243.197.30]:42346) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kst7U-0003q2-MN for bug-gnu-emacs@gnu.org; Fri, 25 Dec 2020 14:51:27 -0500 Original-Received: from localhost (localhost [127.0.0.1]) by mail.hostpark.net (Postfix) with ESMTP id 975DA165D1 for ; Fri, 25 Dec 2020 20:51:20 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=bernoul.li; h= content-type:content-type:mime-version:message-id:date:date :subject:subject:from:from:received:received; s=sel2011a; t= 1608925880; bh=QKg9yXHWSqcTt34lRoGqwyyOgsFoqFxy8xrx+FDJOoY=; b=U nHsaR51E+24F48vTCKimCL5EzF0tUFsEWYf6MYi22m2W9KfMq4Y8C1nDUoHifkNx wfhm0ZNAPu6IFgvnxgvT4TLYCn0wjNtdSE8CImrxzxaytcJ6K2AfKH37xkBi0FJQ +iEGpwwwqGFDlniGdXyUSPU6TaR8JJ7UIcIRr/IY0Y= X-Virus-Scanned: by Hostpark/NetZone Mailprotection at hostpark.net Original-Received: from mail.hostpark.net ([127.0.0.1]) by localhost (mail0.hostpark.net [127.0.0.1]) (amavisd-new, port 10224) with ESMTP id vt5cnBUT-ED9 for ; Fri, 25 Dec 2020 20:51:20 +0100 (CET) Original-Received: from customer (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-256) server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.hostpark.net (Postfix) with ESMTPSA id 62AB2165BD for ; Fri, 25 Dec 2020 20:51:20 +0100 (CET) Received-SPF: none client-ip=212.243.197.30; envelope-from=jonas@bernoul.li; helo=mail.hostpark.net X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 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_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:196715 Archived-At: I wrote magit's info manual using an org file before org-mode itself switched the input format of its own manual from texinfo to org. At the time it was necessary to improve upon "ox-texinfo.el" to make it suitable for a large manual. While that may not be the cases anymore, I have kept using my extended exporter implemented in "ox-texinfo+.el" and would like to keep doing so. I am guessing that [non]gnu elpa currently use the version of org that comes with Emacs. It would be nice if we could also use the libraries in org's "contrib/lisp/" directory. Transient's manual needs "ox-extra.el" library from that directory. Magit's additionally needs "org-man.el". "ox-texinfo+.el" is not part of org's "contrib/lisp/" directory and would have to be added separately to the machines that build the gnu and nongnu and elpas. I would need it for the following three features: ;; 1. Create `@deffn' and similar definition items by writing list ;; items in Org that look similar to what they will look like in ;; Info. To enable this, add: ;; ;; #+TEXINFO_DEFFN: t ;; ;; to your Org file. After doing that, you can create definition ;; items like so: ;; ;; - Command: magit-section-show ;; ;; Show the body of the current section. ;; ;; - Function: magit-git-exit-code &rest args ;; - Macro: magit-insert-section &rest args ;; - Variable: magit-display-buffer-noselect ;; - User Option: magit-display-buffer-function ;; - Key: q, magit-mode-bury-buffer ;; 2. Optionally share a section's node with some or all of its child ;; sections. By default every section on every level gets its own ;; node, and `ox-texinfo' provides no mechanism for changing that. ;; To place a section in the same node as its parent section, do ;; this: ;; ;; **** Log Performance ;; :PROPERTIES: ;; :NONODE: t ;; :END: ;; 3. Optionally modify the Org file before exporting it. This is ;; implemented using a hook that can be set using the `BIND' ;; property: ;; ;; #+BIND: ox-texinfo+-before-export-hook some-function ;; #+BIND: ox-texinfo+-before-export-hook another-function ;; ;; The function `ox-texinfo+-update-version-strings' is provided ;; as an example. It makes some assumptions that might not be ;; appropriate for your manuals, so you might have to define your ;; own variant. (The third feature can also be invoked using a make target and this needs some love to work properly with "elpa-admin.el", but that's a detail.) You can use git or a browser to get "ox-texinfo+.el" from https://github.com/tarsius/ox-texinfo-plus. Please consider making "org/contrib/lisp/" and "ox-texinfo+.el" available to the elpas. Jonas