From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#36417: [PATCH] Document bookmark annotations in Emacs Manual Date: Fri, 28 Jun 2019 17:13:33 +0200 Message-ID: References: <83y31lhjwz.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="0000000000007a4296058c63b9ef" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="231805"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 36417@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Jun 28 17:22:57 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hgsiG-000y9l-D1 for geb-bug-gnu-emacs@m.gmane.org; Fri, 28 Jun 2019 17:22:56 +0200 Original-Received: from localhost ([::1]:33188 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hgsiF-0007Hd-CG for geb-bug-gnu-emacs@m.gmane.org; Fri, 28 Jun 2019 11:22:55 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52681) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hgsZf-0002KX-JH for bug-gnu-emacs@gnu.org; Fri, 28 Jun 2019 11:14:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hgsZe-00055p-D0 for bug-gnu-emacs@gnu.org; Fri, 28 Jun 2019 11:14:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:57495) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hgsZe-00055d-8y for bug-gnu-emacs@gnu.org; Fri, 28 Jun 2019 11:14:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hgsZe-0008RA-1m for bug-gnu-emacs@gnu.org; Fri, 28 Jun 2019 11:14:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 28 Jun 2019 15:14:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 36417 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 36417-submit@debbugs.gnu.org id=B36417.156173483332402 (code B ref 36417); Fri, 28 Jun 2019 15:14:01 +0000 Original-Received: (at 36417) by debbugs.gnu.org; 28 Jun 2019 15:13:53 +0000 Original-Received: from localhost ([127.0.0.1]:42806 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hgsZU-0008QY-RR for submit@debbugs.gnu.org; Fri, 28 Jun 2019 11:13:53 -0400 Original-Received: from mail-wm1-f48.google.com ([209.85.128.48]:37286) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hgsZS-0008QI-OQ for 36417@debbugs.gnu.org; Fri, 28 Jun 2019 11:13:51 -0400 Original-Received: by mail-wm1-f48.google.com with SMTP id f17so9319506wme.2 for <36417@debbugs.gnu.org>; Fri, 28 Jun 2019 08:13:50 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=gYovZ+aNfREAsMeWf9Js+lFC/ahts2lbRMS5mf+ICNM=; b=PUsDjQw9e4zxt6/KDSGgfZbL7sV4XbW2EiwBWkdFISNEI//PndRHmZchyWc4/92VW0 qzb69StjZRKLIxHzDod9IoVOkPWlBvn29UP52yxJvUWyJz74yn07nBHkJGH2bIGAq5aF EzGPzZwiAhCGXGCAAfyWFYGr+6QPIVc+kG2tEA4OAZpNGfe8pbtJ7aPL5XNr1Q/LhQVu 3IC42tvj01FIqjo3WGNk3tUfFuJ4IbV11FcOp71GGXdc+F6oe5JBg4QblCw+0ierm6AV sciZXiMIh/OSjN9PPwJT3M1sUyEA7G2XiF0r1Tl2B+rEC1X9PW+nxk/AIJhPGGQVWgHp mD0Q== X-Gm-Message-State: APjAAAU3d0a1qfuTO3E8/DNSb/+4Ag6uI4VVvAJnx10fkExVnZZYOq2Y BgImYEORpNqF6nYna/AnrfhCWr+WsX4Xj3AqsDM= X-Google-Smtp-Source: APXvYqymbEQAxA/iMjN/yODtmPqHL8DjNQpCkXGY52wzRlmE8Khs5P+SMOTjWhpjj08TZnyp8C85fDO9GO7hE1G2Ekw= X-Received: by 2002:a1c:f515:: with SMTP id t21mr8065886wmh.39.1561734824984; Fri, 28 Jun 2019 08:13:44 -0700 (PDT) In-Reply-To: <83y31lhjwz.fsf@gnu.org> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:161732 Archived-At: --0000000000007a4296058c63b9ef Content-Type: text/plain; charset="UTF-8" Eli Zaretskii writes: > > +@vindex bookmark-use-annotations > > +@vindex bookmark-automatically-show-annotations > > How about "@cindex bookmark annotations" as well? Done. > > + If you set the variable @code{bookmark-use-annotations} to t, > ^ > @code{t} Done. Would we also want to do this change while we're at it, or is it ok as is? - If you set the variable @code{bookmark-save-flag} to 1, each command + If you set the variable @code{bookmark-save-flag} to @code{1}, each command > > +setting a bookmark will query for an annotation. The annotation will > > +be automatically shown when you jump to that bookmark. > > Please explain what does "show" mean in this context. Done. Let me know if it's not clear enough. > Btw, what is the use case for using annotations but not showing them? > If that use case is not important enough, perhaps we shouldn't mention > the second option. Good point. I don't think it's a very important use case, so I removed it. Thank you for reviewing; sorry about the basic mistakes. Please find attached an updated patch. Thanks, Stefan Kangas --0000000000007a4296058c63b9ef Content-Type: text/x-patch; charset="US-ASCII"; name="0001-Document-bookmark-annotations-in-Emacs-Manual.patch" Content-Disposition: attachment; filename="0001-Document-bookmark-annotations-in-Emacs-Manual.patch" Content-Transfer-Encoding: base64 Content-ID: X-Attachment-Id: f_jxg8jxyx0 RnJvbSAyNTFkNGIzZGU5OTRhNGQ5YTU1ZTJlYzk0YTNjOTk0NWQ0Mjk3ZDM4IE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBTdGVmYW4gS2FuZ2FzIDxzdGVmYW5rYW5nYXNAZ21haWwuY29t PgpEYXRlOiBGcmksIDI4IEp1biAyMDE5IDEzOjQwOjM3ICswMjAwClN1YmplY3Q6IFtQQVRDSF0g RG9jdW1lbnQgYm9va21hcmsgYW5ub3RhdGlvbnMgaW4gRW1hY3MgTWFudWFsCgoqIGRvYy9lbWFj cy9yZWdzLnRleGkgKEJvb2ttYXJrcyk6IERvY3VtZW50IGFubm90YXRpb25zLgoqIGxpc3AvYm9v a21hcmsuZWwgKGJvb2ttYXJrLXVzZS1hbm5vdGF0aW9ucyk6IENsYXJpZnkgZG9jc3RyaW5nLgot LS0KIGRvYy9lbWFjcy9yZWdzLnRleGkgfCA3ICsrKysrKysKIGxpc3AvYm9va21hcmsuZWwgICAg fCA1ICstLS0tCiAyIGZpbGVzIGNoYW5nZWQsIDggaW5zZXJ0aW9ucygrKSwgNCBkZWxldGlvbnMo LSkKCmRpZmYgLS1naXQgYS9kb2MvZW1hY3MvcmVncy50ZXhpIGIvZG9jL2VtYWNzL3JlZ3MudGV4 aQppbmRleCAzNzAyNjk0NjQ3Li4xYzhlMzM4ZTY1IDEwMDY0NAotLS0gYS9kb2MvZW1hY3MvcmVn cy50ZXhpCisrKyBiL2RvYy9lbWFjcy9yZWdzLnRleGkKQEAgLTM1OSw2ICszNTksMTMgQEAgQm9v a21hcmtzCiAgIFRoZSB2YXJpYWJsZSBAY29kZXtib29rbWFyay1kZWZhdWx0LWZpbGV9IHNwZWNp ZmllcyB0aGUgZmlsZSBpbgogd2hpY2ggdG8gc2F2ZSBib29rbWFya3MgYnkgZGVmYXVsdC4KIAor QHZpbmRleCBib29rbWFyay11c2UtYW5ub3RhdGlvbnMKK0BjaW5kZXggYm9va21hcmsgYW5ub3Rh dGlvbnMKKyAgSWYgeW91IHNldCB0aGUgdmFyaWFibGUgQGNvZGV7Ym9va21hcmstdXNlLWFubm90 YXRpb25zfSB0byBAY29kZXt0fSwKK3NldHRpbmcgYSBib29rbWFyayB3aWxsIHF1ZXJ5IGZvciBh biBhbm5vdGF0aW9uLiAgVGhlIGFubm90YXRpb24gd2lsbAorYmUgYXV0b21hdGljYWxseSBzaG93 biBpbiBhIHNlcGFyYXRlIHdpbmRvdyB3aGVuIHlvdSBqdW1wIHRvIGEKK2Jvb2ttYXJrLgorCiBA dmluZGV4IGJvb2ttYXJrLXNlYXJjaC1zaXplCiAgIEJvb2ttYXJrIHBvc2l0aW9uIHZhbHVlcyBh cmUgc2F2ZWQgd2l0aCBzdXJyb3VuZGluZyBjb250ZXh0LCBzbyB0aGF0CiBAY29kZXtib29rbWFy ay1qdW1wfSBjYW4gZmluZCB0aGUgcHJvcGVyIHBvc2l0aW9uIGV2ZW4gaWYgdGhlIGZpbGUgaXMK ZGlmZiAtLWdpdCBhL2xpc3AvYm9va21hcmsuZWwgYi9saXNwL2Jvb2ttYXJrLmVsCmluZGV4IDlh M2EyYTNiZGYuLmJiZWYwYTkyN2QgMTAwNjQ0Ci0tLSBhL2xpc3AvYm9va21hcmsuZWwKKysrIGIv bGlzcC9ib29rbWFyay5lbApAQCAtMzYsOSArMzYsNiBAQAogCiA7OzsgTWlzYyBjb21tZW50czoK IDs7Ci07OyBJZiB2YXJpYWJsZSBib29rbWFyay11c2UtYW5ub3RhdGlvbnMgaXMgbm9uLW5pbCwg YW4gYW5ub3RhdGlvbiBpcwotOzsgcXVlcmllZCBmb3Igd2hlbiBzZXR0aW5nIGEgYm9va21hcmsu Ci07OwogOzsgVGhlIGJvb2ttYXJrIGxpc3QgaXMgc29ydGVkIGxleGljYWxseSBieSBkZWZhdWx0 LCBidXQgeW91IGNhbiB0dXJuCiA7OyB0aGlzIG9mZiBieSBzZXR0aW5nIGJvb2ttYXJrLXNvcnQt ZmxhZyB0byBuaWwuICBJZiBpdCBpcyBuaWwsIHRoZW4KIDs7IHRoZSBsaXN0IHdpbGwgYmUgcHJl c2VudGVkIGluIHRoZSBvcmRlciBpdCBpcyByZWNvcmRlZApAQCAtNTIsNyArNDksNyBAQCBib29r bWFyawogCiAKIChkZWZjdXN0b20gYm9va21hcmstdXNlLWFubm90YXRpb25zIG5pbAotICAiSWYg bm9uLW5pbCwgc2F2aW5nIGEgYm9va21hcmsgcXVlcmllcyBmb3IgYW4gYW5ub3RhdGlvbiBpbiBh IGJ1ZmZlci4iCisgICJJZiBub24tbmlsLCBzZXR0aW5nIGEgYm9va21hcmsgcXVlcmllcyBmb3Ig YW4gYW5ub3RhdGlvbiBpbiBhIGJ1ZmZlci4iCiAgIDp0eXBlICdib29sZWFuCiAgIDpncm91cCAn Ym9va21hcmspCiAKLS0gCjIuMTEuMAoK --0000000000007a4296058c63b9ef--