From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Yuan Fu Newsgroups: gmane.emacs.devel Subject: Re: Writing manuals Date: Tue, 17 Aug 2021 20:24:55 -0700 Message-ID: <6EB979D9-EDD7-4F4B-B3CF-8FDC345F6E42@gmail.com> References: <60B2E271-2E91-4906-940E-425A76ED0DCD@gmail.com> <83czqc715e.fsf@gnu.org> <502702DF-70A7-4FCC-93FD-08E984673832@gmail.com> <83tujo56oj.fsf@gnu.org> <83o89v6hsd.fsf@gnu.org> <83eear5vys.fsf@gnu.org> Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.60.0.2.21\)) Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36606"; 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 Wed Aug 18 05:25:40 2021 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 1mGCCy-0009Kb-6b for ged-emacs-devel@m.gmane-mx.org; Wed, 18 Aug 2021 05:25:40 +0200 Original-Received: from localhost ([::1]:34526 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mGCCw-0002xC-Na for ged-emacs-devel@m.gmane-mx.org; Tue, 17 Aug 2021 23:25:38 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44704) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mGCCK-0002Fo-Jq for emacs-devel@gnu.org; Tue, 17 Aug 2021 23:25:00 -0400 Original-Received: from mail-pl1-x631.google.com ([2607:f8b0:4864:20::631]:43830) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mGCCJ-0007B8-5a; Tue, 17 Aug 2021 23:25:00 -0400 Original-Received: by mail-pl1-x631.google.com with SMTP id e19so921636pla.10; Tue, 17 Aug 2021 20:24:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=MO3RDFmKYEGCXAfIw8+/eq2HBbqG4n+7ZCYvneoVzzI=; b=t5RQ9fo9Aemd0BgZUUmZFnRTdklGsPf0yPalXH51ET/+oelXVsrC7XTOgGl8VS7VJB soNenajCFkR33fjBQj2SS9qKkdcTurEzeK2nXm9BpHyu7GmHtGR8x4A7xXHQme3f2V+E ChP3mkhbQiBp1byLv9aq74xMoCjRI/QjhqkG7h+i3IqtMgJ6T1YRj86gT9ddAV3wnSeY wifNEr32IJE2Vc9RRiJ2YaVTTfCIKX++sQjcfGu0Zp31pFmNjqPvCFS4Xwg+qIzwWm4p HE4t+4lrmZqmzEaDgTp444n470/rlGJH7QgHaOcY6W2x8N4N57sYFA46XCcKYibHs1Rz pbZw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=MO3RDFmKYEGCXAfIw8+/eq2HBbqG4n+7ZCYvneoVzzI=; b=XJehIO1xqfY/KHDLWSGWCdB8vGBfdiIrP5n4yDLv1DT/ITpf6lbalGW+4eHWYqoFoX orN5hl4YtecR7OHxYUUj807GyG195mCKLHCTlYLisQbjx4jMerTfsEdaSjJ3dYhHdoCX OcYOJSUe8Er4nHvjL5fKU+kRT7gkgiQVcS0hiyNAkjSplwfv3dW5/hLTQ/CbKtGqLzbh 2lcWiODiLGJf3a0/9EfSMsLVDjJI9bMZF8hpcaOkOIPAz1XJ+ioIK5vRG6U5qxQJ3Hdz ZT8FmHuFMFm4J4CLKw8su3Z0efY7eh1e9SDTjvPHL42vF3hijKAnNNWtHN/SQhr9vhP4 utPA== X-Gm-Message-State: AOAM533PMj5x8tnkx2dx0c4cXkh6bovhDC8QQfyOr+zzLPaVNJ6uaeSL 2tLkwZxMt087zFIFleBczYeaTE80vDo= X-Google-Smtp-Source: ABdhPJxCTaJiI7EJUGp07qX/QwIdrRDUSd+Gw2QtO4NhR8B4w9LbYZP0dkkC85zZ1e3apoXUj3XNRQ== X-Received: by 2002:a17:902:db01:b0:12d:ccb0:f8b1 with SMTP id m1-20020a170902db0100b0012dccb0f8b1mr5573203plx.43.1629257097068; Tue, 17 Aug 2021 20:24:57 -0700 (PDT) Original-Received: from 2603-8000-d900-871b-5c48-b554-29eb-e75a.res6.spectrum.com (2603-8000-d900-871b-5c48-b554-29eb-e75a.res6.spectrum.com. [2603:8000:d900:871b:5c48:b554:29eb:e75a]) by smtp.gmail.com with ESMTPSA id j5sm3408010pjv.56.2021.08.17.20.24.56 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 17 Aug 2021 20:24:56 -0700 (PDT) In-Reply-To: <83eear5vys.fsf@gnu.org> X-Mailer: Apple Mail (2.3654.60.0.2.21) Received-SPF: pass client-ip=2607:f8b0:4864:20::631; envelope-from=casouri@gmail.com; helo=mail-pl1-x631.google.com 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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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.23 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" Xref: news.gmane.io gmane.emacs.devel:272540 Archived-At: > On Aug 17, 2021, at 7:26 PM, Eli Zaretskii wrote: >=20 >> From: Yuan Fu >> Date: Tue, 17 Aug 2021 13:08:52 -0700 >> Cc: emacs-devel@gnu.org >>=20 >>> No, "Text" is for other stuff. I think a separate chapter, = something >>> like "Parsing Program Source". As long as you are talking about >>> general-purpose parsing functions, not their use for font-lock etc. >>=20 >> Ok, I would name it =E2=80=9CParsing Program Source with = Tree-sitter=E2=80=9D, because it isn=E2=80=99t a generic parsing = facility, but really a tree-sitter integration. >=20 > No, please don't use TS-specific chapter names. In the text, you can > tell that the functions you describe require the tree-sitter library, > but the chapter and section names should ideally be neutral, so we > could later add stuff provided by other libraries, like LSP. Ok, then can I mention tree-sitter in section titles? The tentative = sections are: * Language definitions:: Loading tree-sitter language definitions. * Using parsers:: Introduction to parsers. * Accessing nodes:: Accessing syntax nodes. * Pattern matching:: Pattern matching with query patterns. * Query syntax:: Introducing pattern matching query syntax. * Multiple languages:: Parse buffers written in multiple languages. * API correspondence:: Correspondence between C API and ELisp API. * Parse a string:: Parse a single string. They are all tree-sitter specific. How would we later add manual for = other tools like LSP? Maybe I should add a tree-sitter section and move = all these into tree-sitter=E2=80=99s subsections? Then the structure = would be like Chapter: Parsing Program Sources Sections:=20 - tree-sitter - Language definitions - Using parsers ... - LSP - some other tool Yuan=