From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eric Abrahamsen Newsgroups: gmane.emacs.bugs Subject: bug#59121: 29.0.50; Gnus: Nnir is deprecated but not mention in the manual Date: Fri, 11 Nov 2022 11:10:50 -0800 Message-ID: <87tu35johx.fsf@ericabrahamsen.net> References: <874jv9wuve.fsf@thaodan.de> <87y1sljgas.fsf@ericabrahamsen.net> <87tu39jfjo.fsf@ericabrahamsen.net> <87wn84vg33.fsf@thaodan.de> Mime-Version: 1.0 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="9150"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 59121-done@debbugs.gnu.org To: =?UTF-8?Q?Bj=C3=B6rn?= Bidar Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Nov 11 20:11:34 2022 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 1otZR7-00023x-Io for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 11 Nov 2022 20:11:33 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1otZQe-0002Ja-81; Fri, 11 Nov 2022 14:11:04 -0500 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 1otZQc-0002JB-Vo for bug-gnu-emacs@gnu.org; Fri, 11 Nov 2022 14:11:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1otZQc-0007de-NH for bug-gnu-emacs@gnu.org; Fri, 11 Nov 2022 14:11:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1otZQc-0007dq-3e; Fri, 11 Nov 2022 14:11:02 -0500 Resent-From: Eric Abrahamsen Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org, bugs@gnus.org Resent-Date: Fri, 11 Nov 2022 19:11:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 59121 X-GNU-PR-Package: emacs,gnus Mail-Followup-To: 59121@debbugs.gnu.org, eric@ericabrahamsen.net, bjorn.bidar@thaodan.de Original-Received: via spool by 59121-done@debbugs.gnu.org id=D59121.166819386029363 (code D ref 59121); Fri, 11 Nov 2022 19:11:01 +0000 Original-Received: (at 59121-done) by debbugs.gnu.org; 11 Nov 2022 19:11:00 +0000 Original-Received: from localhost ([127.0.0.1]:46757 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1otZQZ-0007dW-OP for submit@debbugs.gnu.org; Fri, 11 Nov 2022 14:11:00 -0500 Original-Received: from mail.ericabrahamsen.net ([52.70.2.18]:46078) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1otZQY-0007dL-Nz for 59121-done@debbugs.gnu.org; Fri, 11 Nov 2022 14:10:59 -0500 Original-Received: from localhost (unknown [76.135.104.211]) (Authenticated sender: eric@ericabrahamsen.net) by mail.ericabrahamsen.net (Postfix) with ESMTPSA id 763F6FA08F; Fri, 11 Nov 2022 19:10:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericabrahamsen.net; s=mail; t=1668193852; bh=05kbIQzTPHwvwsBFpeVqswQdZ70yO28mn6rQ+O08NYg=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=mNsPXzBROWHKz8Jq6LrCe1YDGaT9LU4KfZEwI/Kfq/gRNkJicxGN0g+eP/187GO8N IFUuzUEcV4K1GC2I5YQApb4CfjYkv55HTgxCMI9Utp3Wy/HaqmP5nsussT5N0TdQ/6 aQTEQXdn5S/76iyUgnkPTQ56pV1w7W4D2qHWVZNA= In-Reply-To: <87wn84vg33.fsf@thaodan.de> ("=?UTF-8?Q?Bj=C3=B6rn?= Bidar"'s message of "Wed, 09 Nov 2022 07:42:40 +0200") 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:247610 Archived-At: On 11/09/22 07:42 AM, Bj=C3=B6rn Bidar wrote: > Eric Abrahamsen writes: > >> Eric Abrahamsen writes: >>>> I think the manual should mention that. I think such changes should be >>>> documented right a way in general. >>> >>> Do you mean that you recently upgraded Emacs, and got a deprecation >>> warning for a nnir-* variable, but there's no information in the Gnus >>> manual about migrating away from nnir? >>> >>> That does seem like an oversight... >> >> Here's a potential documentation patch. > >> diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi >> index 7bcf334297..578273aede 100644 >> --- a/doc/misc/gnus.texi >> +++ b/doc/misc/gnus.texi >> @@ -21900,14 +21900,13 @@ About mairix >> @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} >>=20=20 >> Though mairix might not be as flexible as other search tools like >> -swish++ or namazu, which you can use via the @code{nnir} back end, it >> -has the prime advantage of being incredibly fast. On current systems, = it >> -can easily search through headers and message bodies of thousands and >> -thousands of mails in well under a second. Building the database >> -necessary for searching might take a minute or two, but only has to be >> -done once fully. Afterwards, the updates are done incrementally and >> -therefore are really fast, too. Additionally, mairix is very easy to s= et >> -up. >> +swish++ or namazu, it has the prime advantage of being incredibly >> +fast. On current systems, it can easily search through headers and >> +message bodies of thousands and thousands of mails in well under a >> +second. Building the database necessary for searching might take a >> +minute or two, but only has to be done once fully. Afterwards, the >> +updates are done incrementally and therefore are really fast, too. >> +Additionally, mairix is very easy to set up. >> For maximum speed though, mairix should be used with mails stored in >> @code{Maildir} or @code{MH} format (this includes the @code{nnml} back >> @@ -22545,6 +22544,20 @@ nnmairix caveats >>=20=20 > > What about remote searches such as IMAP? > In any case since the search isn't asynchronous there's the caveat of > Gnus locking up Emacs until it is done. > > This kinda goes out of the original topic but the manual doesn't mention > much what can used to reduce the download when IMAP is used (caching etc.= ). > >> +@node nnir >> +@section Migrating from nnir >> + >> +@cindex nnir >> + >> +Gnus' previous search engine was called nnir, and is now obsolete. If >> +you've upgraded Emacs and are now getting obsolete-variable warnings >> +about @code{nnir-*} variables, migration is fairly straightforward. >> +In addition to the variables raised by the warnings, all previous >> +engine-specific variables can be updated by simply replacing the >> +@code{nnir-} prefix with @code{gnus-search-}. For instance, >> +@code{nnir-notmuch-program} is now @code{gnus-search-notmuch-program}. > > The section should mention the exact version it was deprecated, > instead of now it should be "and is deprecated since ". > Something like a separate section about deprecated items could also be > very useful. Some guide around the internet set variables which are no > longer valid, if there is a section for each item deprecated > with an explanation it could help greatly. I've pushed an update that mentions that IMAP works out of the box, mentions the version the nnir was deprecated, and explains how to update variable settings. I think that will be all -- we shouldn't and can't add a bunch of stuff addressing what users may or may not find on the internet at large. Thanks, Eric