From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Perry Smith Newsgroups: gmane.emacs.devel Subject: Re: Tree-sitter introduction documentation Date: Fri, 16 Dec 2022 14:05:14 -0600 Message-ID: <4C77953A-58AB-4992-A615-F1F0F9C38A82@easesoftware.com> References: <83edszjslp.fsf@gnu.org> <83v8mbi7b9.fsf@gnu.org> <93595C69-560B-45BA-915C-BA74A9BBA712@easesoftware.com> <83o7s3i1i4.fsf@gnu.org> Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3731.200.110.1.12\)) Content-Type: multipart/signed; boundary="Apple-Mail=_68FB7CD7-FDD2-455B-872A-FE036644BFDD"; protocol="application/pgp-signature"; micalg=pgp-sha256 Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="3187"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Dec 16 21:06:42 2022 Return-path: Envelope-to: ged-emacs-devel@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 1p6Gyf-0000gT-1z for ged-emacs-devel@m.gmane-mx.org; Fri, 16 Dec 2022 21:06:41 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1p6Gxp-0006Wd-2f; Fri, 16 Dec 2022 15:05:49 -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 1p6GxZ-0006Qe-Ly for emacs-devel@gnu.org; Fri, 16 Dec 2022 15:05:42 -0500 Original-Received: from beige.elm.relay.mailchannels.net ([23.83.212.16]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1p6GxW-0002jw-6s; Fri, 16 Dec 2022 15:05:32 -0500 X-Sender-Id: a2hosting|x-authuser|pedz+easesoftware.com@mi3-ss4.a2hosting.com Original-Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id C35FC5C1B2E; Fri, 16 Dec 2022 20:05:26 +0000 (UTC) Original-Received: from mi3-ss4.a2hosting.com (unknown [127.0.0.6]) (Authenticated sender: a2hosting) by relay.mailchannels.net (Postfix) with ESMTPA id F35B25C1DFD; Fri, 16 Dec 2022 20:05:25 +0000 (UTC) ARC-Seal: i=1; s=arc-2022; d=mailchannels.net; t=1671221126; a=rsa-sha256; cv=none; b=PNpaRhG+sKBrsX/OahKlhIZ88jkjM7/zhB5AvpSktfPIr7LEypZMDNay9RTLSpygoWxEdE CVV3h+ncN90rYRzJrVgQbJo+Xbc4dGVZpbn6qiwrq+VybZVrPrwU6hUP+60At4QfHPpUgX DR1RywQuolCSiTKNSMY3okAP4XC5EqhGCJUGWggCAyrupMXD7xe3O3E6m/ZVV/YU9ZjkXH uCVfSDaGtXHC8GwvTWHRPF/P+WwAtmxpcwryY/Cv5OqcwvGDqUE4MbyieZHkM5slhT5eJM dvimetv0S9QxFFrw+dcra1YoiDAWY9qL40pQq2Jl++g2VZvSpTRZ4zvcliD+Fg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=mailchannels.net; s=arc-2022; t=1671221126; 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:dkim-signature; bh=rUP9HQEKX6NpDhlqHXfZxsEjq/JL2Rr4HNYttJ0BKS0=; b=GV4sOt+Z3n7F23ChF9jKU8TZBogmq9EJQxLyAUTuRR06dq/fX3/BXZBQmYYQimMfNUqB33 15Cte0dO5ifGgaI1W3YY22DjzTZl2dkXcwoWMTFNCTWdRMkXoxlqa1dOlmTOgYiLHMZpGO IIcIICd+vtwh4L7IMBMpN9BMsVU3ZhUJSODwbwkTNsHZ2c9Zc9Mfn8A9ew5yPFkfXYa8fE xzwS0mU3x0CcN4/PhWGPCLhCLgBWOmRc/z35dV+ycHiGJ5vhf2isUJj5NbM9nb7A2b9meE N2mHJH4Qlx25f663C9zgXzKYh8EbxAe8A+hbkLeNheL94X2SkLdTnhfjMgOFOw== ARC-Authentication-Results: i=1; rspamd-56db58bdfc-47zsc; auth=pass smtp.auth=a2hosting smtp.mailfrom=pedz@easesoftware.com X-Sender-Id: a2hosting|x-authuser|pedz+easesoftware.com@mi3-ss4.a2hosting.com X-MC-Relay: Neutral X-MailChannels-SenderId: a2hosting|x-authuser|pedz+easesoftware.com@mi3-ss4.a2hosting.com X-MailChannels-Auth-Id: a2hosting X-Shoe-Coil: 105cfa47195d4349_1671221126430_1813415359 X-MC-Loop-Signature: 1671221126430:3553532707 X-MC-Ingress-Time: 1671221126430 Original-Received: from mi3-ss4.a2hosting.com (mi3-ss4.a2hosting.com [68.66.200.199]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384) by 100.126.30.43 (trex/6.7.1); Fri, 16 Dec 2022 20:05:26 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=easesoftware.com; s=default; h=To:References:Message-Id:Cc:Date:In-Reply-To :From:Subject:Mime-Version:Content-Type: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=rUP9HQEKX6NpDhlqHXfZxsEjq/JL2Rr4HNYttJ0BKS0=; b=aO9VM99Jk0HH96iqV6soVLUXXv bgNht0G1mQav343s7XPCH2yfyDIidNABaMHp6FdmWLmlzGGAP2vBQPUN4G7YE4OA4A0FSDOFuugY5 TFadvXAunpjF02H9ON9k/YcHJJUCbNvHoMTYjQ/SJDELxYMoqlnPTIZEVhlvC8aCYW/7843DyTOSU 3uBnKHw+QFoHrtzkV3Dz6z1r8cpeMzB3kmusjue5rRVujEVncYDBoUwiM3XhPNHuz5OMA3RNNQS3A P6sLbzgPHg1midTpmqv0B9Tag/PtegJCAN3drU4wrfWx/sN7jHR9uhDsVcdHhY2Yw2GSNDmH1gX83 hSrDo6Pg==; Original-Received: from cpe-70-94-128-193.satx.res.rr.com ([70.94.128.193]:60417 helo=smtpclient.apple) by mi3-ss4.a2hosting.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1p6GxQ-007Z9n-Vq; Fri, 16 Dec 2022 15:05:25 -0500 In-Reply-To: <83o7s3i1i4.fsf@gnu.org> X-Mailer: Apple Mail (2.3731.200.110.1.12) X-AuthUser: pedz+easesoftware.com@mi3-ss4.a2hosting.com Received-SPF: pass client-ip=23.83.212.16; envelope-from=pedz@easesoftware.com; helo=beige.elm.relay.mailchannels.net X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:301523 Archived-At: --Apple-Mail=_68FB7CD7-FDD2-455B-872A-FE036644BFDD Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 > On Dec 16, 2022, at 13:37, Eli Zaretskii wrote: >=20 >> From: Perry Smith >> Date: Fri, 16 Dec 2022 13:08:45 -0600 >> Cc: emacs-devel@gnu.org >>=20 >>>>> My main problem is where to put this stuff. >>>>=20 >>>> There are tree sitter Info pages in the ELisp topic but I would add = some to Emacs topic as well. Perhaps under >>>> Advanced Features >>>> Tree Sitter >>>> Setup and Getting Started >>>> Font lock =E2=80=94 describe the =E2=80=9Cfeatures=E2=80=9D = concept, treesit-font-lock-level and = treesit-font-lock-recompute-features >>>>=20 >>>> The other topics seem more appropriate in ELisp which already = exist. >>>=20 >>> This is not relevant to ELisp, so the ELisp Reference manual is not = an >>> appropriate place for this stuff. >>=20 >> We might be talking about two different things. In >> admin/notes/tree-sitter/html-manual are 10 html documents. For >> example one is titled "Accessing Node Information". All of those = come >> from nodes within the ELisp Info doc. e.g. >>=20 >> = https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/lispref/parsing.texi#= n875 >>=20 >> That seems like the right place for those nodes since they are rather >> low level. >>=20 >> The higher level user interface concepts I would think would need to >> be in the Emacs Info tree as I suggested. >=20 > This all started (for me, anyway), when you wrote: >=20 >> Emacs needs to be compiled with tree-sitter enabled >> The tree sitter binary needs to be installed >> The tree sitter language specific parser needs to be installed >> The appropriate major mode needs to be loaded and enabled >>=20 >> Is there a page either in Info or on the web that contains all these = steps? >=20 > I interpreted "all these steps" as meaning the description of how to > do all of the above: compile Emacs with tree-sitter enabled, install > the tree-sitter library, install the language grammar libraries. By > contrast, the information to which you point is about writing code > that accesses parsing results provided by the tree-sitter library, a > very different kind of topic. That topic _is_ described in the ELisp > manual, see the file doc/lispref/parsing.texi. Ah=E2=80=A6 I see. I took the =E2=80=9CThis=E2=80=9D of =E2=80=9CThis = is not relevant =E2=80=A6=E2=80=9D to be about =E2=80=9CThe other topics = =E2=80=A6=E2=80=9D --Apple-Mail=_68FB7CD7-FDD2-455B-872A-FE036644BFDD Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename=signature.asc Content-Type: application/pgp-signature; name=signature.asc Content-Description: Message signed with OpenPGP -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEE5yOa/gCtQpb3oCpljxzk9yzE+MAFAmOcz3oACgkQjxzk9yzE +MDs1g/+IzBtK5j6ydFu1K31IflGHuSRb0P+dq8SVd2eEv2PLbYAtW2cRqpPp4wy yU6LE/Rb2fBsKCHnbKodL4ueUiUozodcJcHn5Pp+8Tb6tMLInGcrB/k+OvLcMoVN 4dRJzXZ/KboIWrkL6NlWENFUykvr48uhC9vFiX9U52QhJx6KXGtFL/KkDg+7TaQo zU/8vMaPRf9gLK+ywm6VNeFvKjxF5AotUiJuBgBTYtS6mM2ukTjtaWdzK0P5UYXN ESxeqRgJN9T72ITqGeu+xVsJy2opCm8PEv97lg8utqkesLsvVXZjVzTcjhKyQ0BG aijLhyH3PrPst90+VwmFXMaciF7OeWy0q4NQeInS10kIeSrJ5fHhN/MSh8LQ6/J3 iAK5Gxne4cPT/tNSd7nyzyceYuQ39mRfPFxqoCz6wGhgjvhtNKElNQRtvUL18iaI 9NMle3n1Ppb2jOcrQKOI71Z35OSHyWs0N5H6N1xoKsBptlIATFu/idRn8mOwKf9I vjtOwQYt/n0a/B8qizw3uDbW69fZfwcQzePbmXNfj6zu2hTUvbKYg87Z3zrBbOLg lFoIVWf392VD/BxqH3jQ9e/30KsMounMgrZao0iEJ00gWheDDIcGm0P7S8t+g4GB EPXidFfm1nZ4o16U7zxKtwxXbRe+yctcfZ+VS7kb4ifeCOGZ8L8= =DaqC -----END PGP SIGNATURE----- --Apple-Mail=_68FB7CD7-FDD2-455B-872A-FE036644BFDD--