From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Ihor Radchenko Newsgroups: gmane.emacs.bugs Subject: bug#66067: 30.0.50; CONTRIBUTE: Questions about instructions on etc/NEWS file markup Date: Mon, 18 Sep 2023 08:38:44 +0000 Message-ID: <87cyyfkh9n.fsf@localhost> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16911"; mail-complaints-to="usenet@ciao.gmane.io" To: 66067@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Sep 18 10:39:17 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 1qi9mm-00049H-Hb for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 18 Sep 2023 10:39:16 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qi9mR-0003gQ-Mu; Mon, 18 Sep 2023 04:38:55 -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 1qi9mQ-0003ds-Kq for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 04:38:54 -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 1qi9mQ-0005Qu-8P for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 04:38:54 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qi9mY-0007S9-AC for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 04:39:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Ihor Radchenko Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 18 Sep 2023 08:39:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66067 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.169502628628575 (code B ref -1); Mon, 18 Sep 2023 08:39:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 18 Sep 2023 08:38:06 +0000 Original-Received: from localhost ([127.0.0.1]:52040 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qi9le-0007Qo-2M for submit@debbugs.gnu.org; Mon, 18 Sep 2023 04:38:06 -0400 Original-Received: from lists.gnu.org ([2001:470:142::17]:52814) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qi9lZ-0007Pp-Mn for submit@debbugs.gnu.org; Mon, 18 Sep 2023 04:38: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 1qi9lI-0002Db-Qn for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 04:37:45 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qi9lB-0005E0-Al for bug-gnu-emacs@gnu.org; Mon, 18 Sep 2023 04:37:43 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 6D2DA240029 for ; Mon, 18 Sep 2023 10:37:30 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1695026250; bh=c6WOW6tnM8nOjOZPiNCieGrGa7NVE4f2/VP5GtMVvQI=; h=From:To:Subject:Date:Message-ID:MIME-Version:From; b=i/Vwou49Qpc8c7foW3DfwKtA5BLGyeD5F58ZgZQgVzVCMraBkU9Dt77WyKvBZcQNT 6palBx9Nd1PHpAbTHuTuAGYx+Pu9d2DW9WXdlTk61VymTGurst+Fr5JN08OgviC6MM /8oe5skpFs7W07xmO/Rckvk5YNiLAy/WwymG6eGNLo4VxVDxU0STGDTMVHl1TiMQnx hNlbbl085oOWml/lQkj4vT2e6r8ynRZbF+va7p9k07ksWKxllj1fX69KS+3LRXAoWa T1bQ5manwy9vx56pd1Vs+aWiVbivJLsJoCwXypWcFJ6pJwfshNpeeOZMJto+SUyG9d zr4FbNtE3VYWw== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Rpypd3SFQz9rxM for ; Mon, 18 Sep 2023 10:37:29 +0200 (CEST) Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.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, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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:270756 Archived-At: Hi, When writing the NEWS entry for bug#65469, I was trying to follow the instructions in CONTRIBUTE file. However, not everything was very clear and I had to consult the git log, other entries, and do some guess work. In particular: 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. 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. 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. 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. I _guessed_ that the quoting should be similar to docstring style, but using "..." quotes instead of `...' and adding space in "(manual) Section" instead of `(manual)Section' used in the docstrings. I believe that the above and any other conventions should be explained better. In GNU Emacs 30.0.50 (build 3, x86_64-pc-linux-gnu, GTK+ Version 3.24.38, cairo version 1.17.8) of 2023-09-15 built on localhost Repository revision: 8a29da91bdcbffe2d7a67f04e235cdf238bd4be8 Repository branch: master Windowing system distributor 'The X.Org Foundation', version 11.0.12101008 System Description: Gentoo Linux -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at