From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#40773: newsticker documentation Date: Wed, 29 Apr 2020 10:58:47 +0300 Message-ID: <838sie205k.fsf@gnu.org> References: <20200422155528.ccsjljhamqeaocsd@E15-2016.optimum.net> <87h7x33ggs.fsf@panama> <20200429041745.srdhgypy5v27e3mv@E15-2016.optimum.net> Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="115534"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 40773@debbugs.gnu.org To: Boruch Baum Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Apr 29 10:06:14 2020 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 1jThjS-000Tvx-CR for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 29 Apr 2020 10:06:14 +0200 Original-Received: from localhost ([::1]:43088 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jThjR-0001Km-BY for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 29 Apr 2020 04:06:13 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:50758) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jThgP-000531-IV for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 04:05:17 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.90_1) (envelope-from ) id 1jThdT-0002zu-UQ for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 04:03:05 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:58980) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jThdT-0002xO-Dr for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 04:00:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1jThdT-0003yS-Be for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 04:00:03 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 29 Apr 2020 08:00:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 40773 X-GNU-PR-Package: emacs Original-Received: via spool by 40773-submit@debbugs.gnu.org id=B40773.158814715915164 (code B ref 40773); Wed, 29 Apr 2020 08:00:03 +0000 Original-Received: (at 40773) by debbugs.gnu.org; 29 Apr 2020 07:59:19 +0000 Original-Received: from localhost ([127.0.0.1]:42287 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jThcj-0003wV-JP for submit@debbugs.gnu.org; Wed, 29 Apr 2020 03:59:19 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:47376) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jThcg-0003wE-1k for 40773@debbugs.gnu.org; Wed, 29 Apr 2020 03:59:15 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:49852) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jThca-00029g-GI; Wed, 29 Apr 2020 03:59:08 -0400 Original-Received: from [176.228.60.248] (port=3161 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1jThcX-0003FQ-RA; Wed, 29 Apr 2020 03:59:06 -0400 In-Reply-To: <20200429041745.srdhgypy5v27e3mv@E15-2016.optimum.net> (message from Boruch Baum on Wed, 29 Apr 2020 00:18:15 -0400) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-Received-From: 209.51.188.43 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" Xref: news.gmane.io gmane.emacs.bugs:179289 Archived-At: > Date: Wed, 29 Apr 2020 00:18:15 -0400 > From: Boruch Baum > Cc: 40773@debbugs.gnu.org > > On 2020-04-28 15:08, Ulf Jasper wrote: > > Am 22.04.2020 um 11:55 (-0400) schrieb Boruch Baum: > > > I just discovered the existence of `newsticker' bundled into emacs; > > > however, I see not even a cursory mention of it in the emacs manual. At > > > the very least, there should be a short stub entry in the emacs manual, > > > next to the index entry for > > > > > > * Gnus:: A flexible mail and news reader. > > > > You should find newsticker documentation in its own manual: > > > > * Newsticker: (newsticker). A feed reader for Emacs. > > That's great, but the point of my report is that there should be a > reference to it in the emacs manual, and that reference should be > alongside similar emacs packages (eg. gnus). I'm sorry, but that's impractical. Emacs comes with 58 manuals (and 2 FAQ files in Info format) in addition to the 3 "standard" ones. We mention the most important of them in the Emacs manual, but we cannot possible mention all of them. Gnus is so much larger and more important than newsticker that any comparison of how we treat these two is IMO not useful for any practical discussion. Users should become acquainted with the info-display-manual command, and use it whenever they find a package that may have a separate manual. That command offers completion, so it will tell you very quickly whether a given package has an Info manual. Another useful command in this context is "C-h p". E.g., select "news" from the menu this displays, then select "newsticker", and you will see some useful description of the package and its usage. > Further, as a corollary, I suggest that packages bundled in the default > emacs distribution should NOT have info nodes in the emacs section of > the root info index, ie. no duplication. Either the emacs section of the > root info index should be restricted to non-default emacs packages, or > there shouldn't exist such a section at all, and the emacs manual should > have a section for external packages. I don't think I understand what you propose here. What is "the root info index"? is that the Emacs menu in the DIR file, or is that the top-level menu in the emacs.info file?