From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Mekeor Melire Newsgroups: gmane.emacs.bugs Subject: bug#67615: Org-Mode story on how I gathered the list of Emacs-contained online-manuals Date: Tue, 05 Dec 2023 01:06:43 +0000 Message-ID: <87h6kxih4w.fsf@posteo.de> References: <87plzmsuge.fsf@posteo.de> <87leaast8s.fsf@posteo.de> <87sf4ii8oi.fsf@posteo.de> <87o7f6hsfj.fsf@posteo.de> <83msuq5413.fsf@gnu.org> 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="3351"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 67615@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Dec 05 02:18:23 2023 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 1rAK4s-0000dI-O8 for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 05 Dec 2023 02:18:22 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rAK4P-00034T-Cr; Mon, 04 Dec 2023 20:17:53 -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 1rAK4N-000340-SX for bug-gnu-emacs@gnu.org; Mon, 04 Dec 2023 20:17:51 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rAK4N-0001Po-KZ for bug-gnu-emacs@gnu.org; Mon, 04 Dec 2023 20:17:51 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rAK4X-0003ep-Pa for bug-gnu-emacs@gnu.org; Mon, 04 Dec 2023 20:18:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Mekeor Melire Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 05 Dec 2023 01:18:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 67615 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 67615-submit@debbugs.gnu.org id=B67615.170173903314001 (code B ref 67615); Tue, 05 Dec 2023 01:18:01 +0000 Original-Received: (at 67615) by debbugs.gnu.org; 5 Dec 2023 01:17:13 +0000 Original-Received: from localhost ([127.0.0.1]:36169 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rAK3l-0003dl-3B for submit@debbugs.gnu.org; Mon, 04 Dec 2023 20:17:13 -0500 Original-Received: from mout02.posteo.de ([185.67.36.66]:41579) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rAK3i-0003dQ-Ex for 67615@debbugs.gnu.org; Mon, 04 Dec 2023 20:17:11 -0500 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 8C029240101 for <67615@debbugs.gnu.org>; Tue, 5 Dec 2023 02:16:53 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.de; s=2017; t=1701739013; bh=pTELsXqRoHJkkawO0zf890Tpp7YG0EFyaqWzQ+mGZo4=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:From; b=WiYXhvd6rNpN7lKF1Rh+/UCN13I/rWGPASzROkLAft3WWT3j5Zrk2IifcaWv79NPB +scmhXPdLdzJht5O79Z//TZcDv2DQggbaKJXXzps1ki1zu4j3WwHFqr8qrdbsWP2mh K+6o0fn3DaM8Wci38yuIQC1ubhn1IVx89gjhktFiOCLLu7SI3+5iPc7H+vtJbMvUkt xf1StO8T8eWzMN4fpuO1I8UgumxbuDWhx+jcZcqTJHkh+Nko9lohEdvLx3Ux8M1mgu 8cRArEU0Pn+hktxb0vhGzsVkqZ+gWmVEyzi5xPiSfR/T+JAGaQIr+7wqSGI3IYA/Yt Wp8z2XpIXQJqA== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4SkjLD5bmxz6tmv; Tue, 5 Dec 2023 02:16:52 +0100 (CET) In-reply-to: <83msuq5413.fsf@gnu.org> 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-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:275545 Archived-At: --=-=-= Content-Type: text/plain 2023-12-04 18:24 eliz@gnu.org: > > From: Mekeor Melire > > Date: Mon, 04 Dec 2023 15:51:32 +0000 > > > > - Remove "gawk" and "mairix" manual-names from default value of > > Gawk and mairix are not parts of Emacs, they are separately-maintained > programs. So their manuals cannot be reached via the common base of > the Emacs manuals, and therefore they should not be in that list, > indeed. For Gawk, my heuristics for gathering the list of manuals failed for an unknown reason. For mairix, it's "mairix" in https://www.gnu.org/software/emacs/manual/mairix.html but "mairix-el" in https://www.gnu.org/software/emacs/manual/html_node/mairix-el/index.html but I don't know why. That's why my heuristics failed here too. But yeah, "mairix-el" is the right one. To ensure a complete list, I revisited my heuristics and wrote a little story with Org Mode how I gathered the list of Emacs-included online-manuals. Anyone who's really interested, can read the attachment. :D --=-=-= Content-Type: text/x-org Content-Disposition: inline; filename=story.org * Sources Let's gather a list of Emacs-included manuals from different sources. ** Included of Guix-installed Emacs Gather a list of manuals that an Guix-installed Emacs includes: #+begin_src sh :results raw :wrap for f in $(find $(guix package -I | grep emacs-next | cut -f 4)/share/info -type f); do basename $f | cut -d . -f 1 done | sort #+end_src #+NAME: from_guix #+results: #+begin_results auth autotype bovine calc ccmode cl dbus dired-x ebrowse ede ediff edt efaq eglot eieio eintr elisp emacs emacs-gnutls emacs-mime epa erc ert eshell eudc eww flymake forms gnus htmlfontify idlwave ido info mairix-el message mh-e modus-themes newsticker nxml-mode octave-mode org pcl-cvs pgg rcirc reftex remember sasl sc semantic ses sieve smtpmail speedbar srecode todo-mode tramp transient url use-package vhdl-mode vip viper vtable widget wisent woman #+end_results rcirc vtable vhdl-mode ses ido mh-e ccmode efaq info sieve emacs-gnutls mairix-el calc widget message transient cl forms autotype htmlfontify elisp pgg ebrowse wisent auth newsticker pcl-cvs erc sc org nxml-mode remember ediff vip dired-x bovine emacs-mime epa edt semantic eshell use-package gnus viper ert speedbar srecode eww woman idlwave eudc todo-mode dbus eieio eintr ede eglot modus-themes octave-mode url flymake smtpmail emacs sasl reftex tramp ** Mentioned on gnu.org Gather a list of Emacs-included manuals by parsing https://www.gnu.org/software/emacs/manual/. #+begin_src elisp (string-join (sort (seq-map #'cadr (s-match-strings-all "href=\"\\([a-zA-Z0-9_-]+\\)\.html" (plz 'get "https://www.gnu.org/software/emacs/manual/"))) #'string<) "\n") #+end_src #+NAME: from_gnu_org #+RESULTS: #+begin_example auth autotype bovine calc ccmode cl dbus dired-x ebrowse ede ediff edt efaq efaq-w32 eglot eieio eintr elisp emacs emacs-gnutls emacs-mime epa epa erc ert eshell eudc eww flymake forms gnus htmlfontify idlwave ido info mairix message mh-e modus-themes newsticker nxml-mode octave-mode org pcl-cvs pgg rcirc reftex remember sasl sc semantic ses sieve smtpmail speedbar srecode todo-mode tramp transient url use-package vhdl-mode vip viper vtable widget wisent woman #+end_example ** Checked into emacs repository Gather a list of Emacs-included manuals from Emacs' repository; from a local clone in particular. #+begin_src sh :results raw :wrap find ~/store/host/permanent/git/foreign/emacs/doc/misc/ -type f -iname '*.texi' -exec basename \{\} .texi \; | sort #+end_src #+NAME: from_repo #+RESULTS: #+begin_results auth autotype bovine calc cc-mode cl dbus dired-x doclicense ebrowse ede ediff edt efaq efaq-w32 eglot eieio emacs-gnutls emacs-mime epa erc ert eshell eudc eww flymake forms gnus gnus-faq gpl htmlfontify idlwave ido info mairix-el message mh-e newsticker nxml-mode octave-mode pcl-cvs pgg rcirc reftex remember sasl sc semantic sem-user ses sieve smtpmail speedbar srecode todo-mode tramp trampver transient url use-package vhdl-mode vip viper vtable widget wisent woman #+end_results * Merge manual-lists from all sources Merge all sources; make sure each manual-name is unique. #+begin_src sh :var from_guix=from_guix :var from_gnu_org=from_gnu_org :var from_repo=from_repo :results raw :wrap for m in $from_guix $from_gnu_org $from_repo; do echo $m done | sort | uniq #+end_src #+NAME: merged #+RESULTS: #+begin_results auth autotype bovine calc cc-mode ccmode cl dbus dired-x doclicense ebrowse ede ediff edt efaq efaq-w32 eglot eieio eintr elisp emacs emacs-gnutls emacs-mime epa erc ert eshell eudc eww flymake forms gnus gnus-faq gpl htmlfontify idlwave ido info mairix mairix-el message mh-e modus-themes newsticker nxml-mode octave-mode org pcl-cvs pgg rcirc reftex remember sasl sc semantic sem-user ses sieve smtpmail speedbar srecode todo-mode tramp trampver transient url use-package vhdl-mode vip viper vtable widget wisent woman #+end_results * Check online availability of each manual ** Filter manuals with "one page per node" online-manuals #+begin_src sh :var manuals=merged :results raw :wrap for m in $manuals; do if [ 200 = "$(curl -s -i https://www.gnu.org/software/emacs/manual/html_node/$m/index.html | head -n 1 | cut -d ' ' -f 2)" ]; then echo $m; fi done #+end_src #+NAME: available_per_node #+RESULTS: #+begin_results auth autotype bovine calc ccmode cl dbus dired-x ebrowse ede ediff edt efaq efaq-w32 eglot eieio eintr elisp emacs emacs-gnutls emacs-mime epa erc ert eshell eudc eww flymake forms gnus htmlfontify idlwave ido info mairix-el message mh-e modus-themes newsticker nxml-mode octave-mode org pcl-cvs pgg rcirc reftex remember sasl sc semantic ses sieve smtpmail speedbar srecode todo-mode tramp transient url use-package vhdl-mode vip viper vtable widget wisent woman #+end_results ** Filter manuals with "entirely on one page" online-manuals Find out if there are manuals that do not have a "one page per node" online-manual, but have only a "entirely on one page" online-manual. It could be! First, determine those manuals without "one page per node" online-manuals: #+begin_src sh :var merged=merged :var available_per_node=available_per_node :results raw :wrap for m in $merged $available_per_node; do echo $m; done | sort | uniq -c | grep ' 1 ' | rev | cut -d ' ' -f 1 | rev #+end_src #+NAME: not_available_per_node #+RESULTS: #+begin_results cc-mode doclicense gnus-faq gpl mairix sem-user trampver #+end_results Well, these manuals are known to not exist because of following reasons: - cc-mode: It's =cc-mode.texi= but =ccmode.info=: https://git.sv.gnu.org/cgit/emacs.git/tree/doc/misc/cc-mode.texi?h=88a6209a7f881b6cab5f1fd9761f1b8ae7cad6fa#n84 - doclicense: Only used via ~@include ....texi~ - gnus-faq: Only used via ~@include ....texi~ - gpl: Only used via ~@include ....texi~ - mairix: It's "mairix" in https://www.gnu.org/software/emacs/manual/mairix.html but "mairix-el" in https://www.gnu.org/software/emacs/manual/html_node/mairix-el/index.html - sem-user: Only used via ~@include ....texi~ - trampver: Only used via ~@include ....texi~ Thus, there is no (online-)manual for these texi-files, particularly no "entirely on one page" online-manual. * Conclusion See results named =available_per_node= for list of all Emacs-included online manuals. --=-=-=--