From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id ED15BxWpWGcMKQEAe85BDQ:P1 (envelope-from ) for ; Tue, 10 Dec 2024 20:48:21 +0000 Received: from aspmx1.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id ED15BxWpWGcMKQEAe85BDQ (envelope-from ) for ; Tue, 10 Dec 2024 21:48:21 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=tsdye.online header.s=default header.b=I5rWTEPV; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1733863701; a=rsa-sha256; cv=none; b=qU3ZVi5KpWJU/W1lISj5tW4gnVBb5XbxlDgCjYYNHuMOY470Xvuv/OiIHWhHVKiROwK1h9 kzj2kqQjdy43NTh9lw3BsfgN53lpSQ7N6VLb1Y4Du7ApBUgPWPGoPyj73ueNrF+6/9Hy6Z f6VCDBp18GqpO7J/Dr1q8TVd7cUjJ8FEPdBUayhgma5V2BWNgIF7KQBzdXA0KIMedcgnSt qrI2ld9Zd6qTw7w+5I+vRIpe7g69QAuHzfomdf8pRrn9FxE9o30scOT3DWZRfkAcCF9B19 KskAokIKIVcRRcarOsMa1n8VQgH787+ybKiCH87LaYvZt4qg5xllcLTJXLAshg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=tsdye.online header.s=default header.b=I5rWTEPV; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1733863701; 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:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=rXsJToGUZ3XESK5LmciINW2DE7R5qsOdXx8pSNcAPaQ=; b=VB1UfMYXBRgyUsUZUwHHF1AUHKPC489F0l2fHaFVblln19oJVIbE+tDQzdwqBoN0OuSer6 NB9mX4909w5gr/96CBVcos4D6ziOPM4Gxnm9uo3Gn8VEqvLSzUpvF+Af6z5qdW2zo61Si8 2G3HnwxIXS0iuqkjRvB2UsoM9NNmIoelF+p5gmGBVReyjuq2VzsnNs+42032Wwz582sLeC 3IBKo0vCVi0XMETg2oIfTQWOCzyWjmO1S6ThiWw/7VOTeWcyM8Zxwou2QMDGHe4WHe8Sit nT7VKbqzYoFcjberfrNX6v2Hb1hdXd3Dyez+W/ZWZZfQupv5ypQ6Ym2OJAVEfQ== 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 9D2BE7F2A0 for ; Tue, 10 Dec 2024 21:48:20 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tL77U-0001DE-G3; Tue, 10 Dec 2024 15:46:13 -0500 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 1tL77M-0000vW-16 for emacs-orgmode@gnu.org; Tue, 10 Dec 2024 15:46:05 -0500 Received: from omta40.uswest2.a.cloudfilter.net ([35.89.44.39]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tL77J-0002ZK-8f for emacs-orgmode@gnu.org; Tue, 10 Dec 2024 15:46:03 -0500 Received: from eig-obgw-5009a.ext.cloudfilter.net ([10.0.29.176]) by cmsmtp with ESMTPS id KpF4tGho9vH7lL774tZW4P; Tue, 10 Dec 2024 20:45:46 +0000 Received: from box2035.bluehost.com ([74.220.219.237]) by cmsmtp with ESMTPS id L773tCyUblDL5L773twjZ0; Tue, 10 Dec 2024 20:45:45 +0000 X-Authority-Analysis: v=2.4 cv=LLtgQoW9 c=1 sm=1 tr=0 ts=6758a879 a=VozZY++RX3oc2UgfNhVfaA==:117 a=VozZY++RX3oc2UgfNhVfaA==:17 a=MKtGQD3n3ToA:10 a=1oJP67jkp3AA:10 a=RZcAm9yDv7YA:10 a=nJrs4UJQBjcA:10 a=GwY7MmwIAAAA:8 a=bwGbKnmsAAAA:8 a=mDV3o1hIAAAA:8 a=FD2ko6OtAAAA:8 a=NjIK7znJAAAA:8 a=o9zw6IYYAAAA:8 a=uChsZFC9AAAA:8 a=rpqUgkJ6zY0BMSjD4vcA:9 a=4Kct91JtT5sA:10 a=-FEs8UIgK8oA:10 a=VyGCqbPC1deIiMLDOFqi:22 a=nuVVIWbBudwLbAahYuja:22 a=86X56SSjLaiTW6IeLIWp:22 a=O1c1nmEkCxIQdeELtU9r:22 a=BtxB1_lq3pBo68oZtZ_9:22 a=ULtXvzFHYWHLyBAuiDia:22 a=A2tt7buDTgElyBcRWK2c:22 a=1ZBvEmPAInNS7xgDtvbF:22 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tsdye.online; s=default; h=Content-Type:MIME-Version:Message-ID:Date: References:In-Reply-To:Subject:Cc:To:From:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=rXsJToGUZ3XESK5LmciINW2DE7R5qsOdXx8pSNcAPaQ=; b=I5rWTEPVmpJiNSAswVAA6/XqyN AvCw9Z/tc87eHMpvF1mNMWCiDdqIyjQSR68JIa3LkHkXhHA9wllGOZ2uSmtbai61T1oN4k+hsta5Y ZtA1d87nQ5xqaiPZO1IFgi30qKSjnKCQ/VOovrA+L0VahgdLEO9u+5sq3FrG+JKVBJ7RZmJCbIapD fzQf/rRXjckvshFBPiga19clUB5Ygy5wJJjnEcNWKgE9nCbE14qgOqkjQa/8QGzoO3ndDORx/vvZP 8DspykZtTvsjQNBH4L+0H9p2WGa8r8DDIQQx/TL6oloT92UH18h4nuEj3xaCrYwiORWJ1nINJXF9d RPiPA5vA==; Received: from syn-050-113-033-148.res.spectrum.com ([50.113.33.148]:49836 helo=poto-foou.tsdye.online) by box2035.bluehost.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96.2) (envelope-from ) id 1tL772-003Bix-2L; Tue, 10 Dec 2024 13:45:44 -0700 From: "Thomas S. Dye" To: Ihor Radchenko Cc: emacs-orgmode@gnu.org Subject: Re: [TASK] Move babel backend docs from WORG to Org manual In-Reply-To: <87zfl3uxhb.fsf@localhost> (Ihor Radchenko's message of "Tue, 10 Dec 2024 19:52:32 +0000") References: <87zfl3uxhb.fsf@localhost> Date: Tue, 10 Dec 2024 10:45:43 -1000 Message-ID: <87pllzuv0o.fsf@tsdye.online> MIME-Version: 1.0 Content-Type: text/plain; format=flowed X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - box2035.bluehost.com X-AntiAbuse: Original Domain - gnu.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - tsdye.online X-BWhitelist: no X-Source-IP: 50.113.33.148 X-Source-L: No X-Exim-ID: 1tL772-003Bix-2L X-Source: X-Source-Args: X-Source-Dir: X-Source-Sender: syn-050-113-033-148.res.spectrum.com (poto-foou.tsdye.online) [50.113.33.148]:49836 X-Source-Auth: tsd@tsdye.online X-Email-Count: 2 X-Org: HG=bhshared;ORG=bluehost; X-Source-Cap: dHNkeWVvbmw7dHNkeWVvbmw7Ym94MjAzNS5ibHVlaG9zdC5jb20= X-Local-Domain: yes X-CMAE-Envelope: MS4xfPDXgzB93+GuXcTnBKOF3/sbfEPNFqHdJxQe8GgpcceWh0oOTUNKMRKc0WQqlFssoDwOBRrIWkUN4MRAOLNGd7o9KU4nutLPZA9CA2BqINeDBXpvBJw8 AwiL12GOsNZl34iRn3eNGXK2C3ZnosPxNS13FgxoccZKKs0M7RxqEBKNT7SaXi69vHumRYTPc/AUfBKVjczf4/QAVupbBPVepuI= Received-SPF: pass client-ip=35.89.44.39; envelope-from=tsd@tsdye.online; helo=omta40.uswest2.a.cloudfilter.net X-Spam_score_int: 4 X-Spam_score: 0.4 X-Spam_bar: / X-Spam_report: (0.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, FROM_SUSPICIOUS_NTLD=0.499, PDS_OTHER_BAD_TLD=1.999, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Queue-Id: 9D2BE7F2A0 X-Migadu-Scanner: mx13.migadu.com X-Migadu-Spam-Score: -4.96 X-Spam-Score: -4.96 X-TUID: O6odsmb9WGFI Ihor Radchenko writes: > Dear all, > > In my talk https://emacsconf.org/2024/talks/org-update, one of > the tasks > I announced was moving babel documentation from WORG to Org > manual. > Here, I would like to details what should be done for that task. > > This is a big task, but we can split it into much smaller and > simpler tasks. > > I recommend taking documentation from a single language to get > started. > Multiple volunteers (if any) may work on other languages in > parallel. > Please tell us which language you are working on to avoid > conflicts. > Also, feel free to ask anything here or in any other > communication > channel (IRC, Matrix, OrgMeetup) if there are difficulties. > > The general idea is to port files from > https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel > into Org > manual. > > At the end, we should have all the ob- files from > https://git.savannah.gnu.org/cgit/emacs/org-mode.git/tree/lisp > documented in the manual. > > The documentation at various stages of completeness is listed in > https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/languages > (ob-doc-.org). > > For each built-in language, we will need to: > > 1. Find ob-doc-.org file, if any > 2. Make sure that the documentation conforms to > https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/languages/ob-doc-template.org > 3. If it does not, we at least need to indicate undocumented > sections > 4. If possible, may also document the missing parts > 4.1. Sometimes, the language implementations in > lisp/ob- miss > features from the checklist. Such problems should be reported > as > bugs for easier tracking. > 5. The cleaned up documentation should be ported to Org > manual. Tentatively, we can follow the structure of export > backends > as in https://orgmode.org/manual/Exporting.html > 6. If there is no documentation at all, it should be written > So, the first order of business is to ensure that all ob-doc-.org files on Worg are complete by i) creating missing files, ii) editing incomplete files, and iii) checking complete files? Then, once Worg holds complete documentation for each built-in language, port them all to the manual? If so, this seems like a good work flow because the documentation on Worg can be easily reviewed by all before it is ported to the manual. I'm happy to volunteer and will start by creating ob-doc-.org files for undocumented and unmaintained languages: comint, F90, forth, sed, ocaml, ruby, and sass. I don't know or use any of these languages. If someone else does know one and would like to jump in, LMK. All the best, Tom -- Thomas S. Dye https://tsdye.online/tsdye