[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Tree-sitter introduction documentation

From: Perry Smith
Subject: Re: Tree-sitter introduction documentation
Date: Fri, 16 Dec 2022 14:05:14 -0600

> On Dec 16, 2022, at 13:37, Eli Zaretskii <eliz@gnu.org> wrote:
>> From: Perry Smith <pedz@easesoftware.com>
>> Date: Fri, 16 Dec 2022 13:08:45 -0600
>> Cc: emacs-devel@gnu.org
>>>>> My main problem is where to put this stuff.
>>>> 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 — describe the “features” concept, treesit-font-lock-level 
>>>> and treesit-font-lock-recompute-features
>>>> The other topics seem more appropriate in ELisp which already exist.
>>> This is not relevant to ELisp, so the ELisp Reference manual is not an
>>> appropriate place for this stuff.
>> 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.
>> https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/lispref/parsing.texi#n875
>> That seems like the right place for those nodes since they are rather
>> low level.
>> The higher level user interface concepts I would think would need to
>> be in the Emacs Info tree as I suggested.
> This all started (for me, anyway), when you wrote:
>> 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
>> Is there a page either in Info or on the web that contains all these steps?
> 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… I see.  I took the “This” of “This is not relevant …” to be about “The 
other topics …”

Attachment: signature.asc
Description: Message signed with OpenPGP

reply via email to

[Prev in Thread] Current Thread [Next in Thread]