From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#66067: 30.0.50; CONTRIBUTE: Questions about instructions on etc/NEWS file markup Date: Mon, 18 Sep 2023 14:21:54 +0300 Message-ID: <834jjrg20d.fsf@gnu.org> References: <87cyyfkh9n.fsf@localhost> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="14731"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 66067-done@debbugs.gnu.org To: Ihor Radchenko Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Sep 18 13:23:27 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 1qiCLd-0003W1-2p for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 18 Sep 2023 13:23:25 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qiCLI-0006OM-FS; Mon, 18 Sep 2023 07:23:04 -0400 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 1qiCL9-0006Lc-Bh for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 07:22:58 -0400 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 1qiCL8-0007jB-KY for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 07:22:54 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qiCLG-0003F4-P6 for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 07:23:02 -0400 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Mon, 18 Sep 2023 11:23:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 66067 X-GNU-PR-Package: emacs Mail-Followup-To: 66067@debbugs.gnu.org, eliz@gnu.org, yantar92@posteo.net Original-Received: via spool by 66067-done@debbugs.gnu.org id=D66067.169503613312376 (code D ref 66067); Mon, 18 Sep 2023 11:23:02 +0000 Original-Received: (at 66067-done) by debbugs.gnu.org; 18 Sep 2023 11:22:13 +0000 Original-Received: from localhost ([127.0.0.1]:52264 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qiCKT-0003DX-2v for submit@debbugs.gnu.org; Mon, 18 Sep 2023 07:22:13 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54350) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qiCKR-0003DI-AE for 66067-done@debbugs.gnu.org; Mon, 18 Sep 2023 07:22:12 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qiCKB-0007WP-Kq; Mon, 18 Sep 2023 07:21:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=dAZSetQB4S2vHM1uQlTtZ6+e8OyP0VPOCekwjYtGJRQ=; b=FFQndl2S79bS yrvmDRVxeL1bHDcCoiG+17ladg5VMM2oi/shPdlw3GiamhE/9AgTAdvzighE0Iw/P/Zz5jtYbvGK6 H7Rw8OsoDvgGbdVs/BytMhKgd1/ZST5ctIUiOepYqR3Cr/FCq2gyYTGnEYrofB7+cvZ6R7voml6m8 B57KD6IVCRvb0atRN1jrI9aPGGWZ0A5oSzf/0ndCkCdPbLfvPAg0BN8tA+oTGHBEIEUrdGLhATRST SWsytWgZ9v0w+lbcXD6yJkqHPdMkdKdB4El7HOdajBw2CQrK03Tu6wAb4VUR2ZLgC1IR5VHw6r+Pz DtmpavkwK7wm9Bad1caWDA==; In-Reply-To: <87cyyfkh9n.fsf@localhost> (message from Ihor Radchenko on Mon, 18 Sep 2023 08:38:44 +0000) 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:270779 Archived-At: > From: Ihor Radchenko > Date: Mon, 18 Sep 2023 08:38:44 +0000 > > 1. It is not documented whether new NEWS entries should go in front or > at the end of the news list under the same category. That's because "it depends": the entries should be arranged in the order of importance, if possible. Usually, the importance order is not very clear, with rare exceptions, so the order is basically arbitrary. > > 2. CONTRIBUTE states: "Think about whether your change requires updating > the manuals. If you know it does not, mark the NEWS entry with > "---"." > > However, it is not clear what "mark" means. When looking into NEWS > file, I saw things like > > * item 1 > > --- > * item 2 > > ... > > And it is not clear if "---" refers to item 1 or item 2. I'm surprised it wasn't clear, but I added an explicit "before". > 3. "Documenting your changes" section of CONTRIBUTE file refers to > documentation tips section of Elisp manual. However, NEWS file > appears to use a slightly different quoting scheme for variable and > function names. For example, > > ** 'write-region-inhibit-fsync' now defaults to t in interactive mode, > > uses straight quotes '...', not the usual `...' docstring style. We support both styles, and there are strong feelings in both camps. 'Nough said. > 4. I was also confused how to refer to info nodes from NEWS. I found one > example in > > For more information, see the "(eshell) Built-ins" node in the Eshell > manual. > > but the convention is not documented anywhere. There is no such convention. The r_is_ a convention for this in Lisp doc strings, and it is described in the ELisp manual. Closing.