emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Alex Branham <branham@utexas.edu>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] protocol: allow users to disable warning about old style links
Date: Fri, 16 Jun 2017 13:31:31 +0200	[thread overview]
Message-ID: <878tksb23w.fsf@utexas.edu> (raw)
In-Reply-To: <8737b0h33u.fsf@nicolasgoaziou.fr>

[-- Attachment #1: Type: text/plain, Size: 4054 bytes --]

Hi, thanks for the reply.

On Fri 16 Jun 2017 at 06:13, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:

> Hello,
>
> Alex Branham <branham@utexas.edu> writes:
>
>> This patch allows org mode users to disable the warning issued about
>>old org protocol style links. This is important because sometimes (e.g.
>>browser extensions), we don’t have easy control over the format
>>specified.
>
> Thank you.
>
> Wouldn't it be better to report it upstream as a bug? I don't think
> there are many Org protocols applications out there and the conversion
> to the new syntax is easy.

I did report it upstream as a bug. The maintainer is (understandably, I think) hesitant to change since 1) old style links continue to be supported and 2) there’s no way for a browser extension to detect the version of org-mode to install. Since new style links aren’t supported in older org versions (like what comes shipped with Emacs), that could create issues.

>
>> Issuing the warning is annoying because it pops up in a new window.
>
> I think this variable should go in "org-compat.el", so that we can
> remove it when we drop old syntax. It also need
> proper :version, :package-version and :safe keywords.
>
> Another option is to make it a simple `defvar' and have the warning
> message suggesting to set it.

I changed it to a defvar and modified the warning. That seems simpler to me.

I wasn’t sure if defvars should go into org-compat.el (that file says it’s for compatibility issues with older Emacs versions?) or stay where it is. I’ve left it where it is for now but I can move it to org-compat.el if you want me to.

New patch attached and pasted below.

>
> WDYT?
>
>> From 8bfc951308324de8e455128950193c046691f1f8 Mon Sep 17 00:00:00 2001
>> From: Alex Branham <branham@utexas.edu>
>> Date: Wed, 14 Jun 2017 14:06:18 +0200
>> Subject: [PATCH] protocol: allow user to disable warning about old style links
>>
>> ---
>>  lisp/org-protocol.el | 11 +++++++++--
>>  1 file changed, 9 insertions(+), 2 deletions(-)
>>
>> diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el
>> index 825435674..2eb1094e9 100644
>> --- a/lisp/org-protocol.el
>> +++ b/lisp/org-protocol.el
>> @@ -271,6 +271,12 @@ This should be a single regexp string."
>>    :package-version '(Org . "8.0")
>>    :type 'string)
>>
>> +(defcustom org-protocol-warn-about-old-links t
>> +  "If non-nil (the default), issue a warning when org protocol
>> +receives old style links."
>
>   When non-nil, warn when Org protocol receives old style link.
>
>
> Regards,

From 5d04e3a9404b2109751da6e43fba24a7cace00a8 Mon Sep 17 00:00:00 2001
From: Alex Branham <branham@utexas.edu>
Date: Fri, 16 Jun 2017 13:24:44 +0200
Subject: [PATCH] org-protocol: add option to surpress warning about old links

---
 lisp/org-protocol.el | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el
index 825435674..531345b58 100644
--- a/lisp/org-protocol.el
+++ b/lisp/org-protocol.el
@@ -271,6 +271,10 @@ This should be a single regexp string."
   :package-version '(Org . "8.0")
   :type 'string)

+(defvar org-protocol-warn-about-old-links t
+  "If non-nil (the default), issue a warning when org protocol
+receives old style links.")
+
 ;;; Helper functions:

 (defun org-protocol-sanitize-uri (uri)
@@ -618,8 +622,9 @@ CLIENT is ignored."
 			     (if new-style
 				 (funcall func (org-protocol-parse-parameters
 						result new-style))
-			       (warn "Please update your Org Protocol handler \
-to deal with new-style links.")
+			       (when org-protocol-warn-about-old-links
+				 (warn "Please update your Org Protocol handler \
+to deal with new-style links.\n                 You may set `org-protocol-warn-about-old-links' to nil to surpress this message."))
 			       (funcall func result))))
 		    ;; Greedy protocol handlers are responsible for
 		    ;; parsing their own filenames.
--
2.13.1



--
J. Alexander Branham
PhD Candidate
Department of Government
University of Texas at Austin
https://www.jabranham.com

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0002-org-protocol-add-option-to-surpress-warning-about-ol.patch --]
[-- Type: text/x-diff, Size: 1398 bytes --]

From 5d04e3a9404b2109751da6e43fba24a7cace00a8 Mon Sep 17 00:00:00 2001
From: Alex Branham <branham@utexas.edu>
Date: Fri, 16 Jun 2017 13:24:44 +0200
Subject: [PATCH] org-protocol: add option to surpress warning about old links

---
 lisp/org-protocol.el | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el
index 825435674..531345b58 100644
--- a/lisp/org-protocol.el
+++ b/lisp/org-protocol.el
@@ -271,6 +271,10 @@ This should be a single regexp string."
   :package-version '(Org . "8.0")
   :type 'string)
 
+(defvar org-protocol-warn-about-old-links t
+  "If non-nil (the default), issue a warning when org protocol
+receives old style links.")
+
 ;;; Helper functions:
 
 (defun org-protocol-sanitize-uri (uri)
@@ -618,8 +622,9 @@ CLIENT is ignored."
 			     (if new-style
 				 (funcall func (org-protocol-parse-parameters
 						result new-style))
-			       (warn "Please update your Org Protocol handler \
-to deal with new-style links.")
+			       (when org-protocol-warn-about-old-links
+				 (warn "Please update your Org Protocol handler \
+to deal with new-style links.\n                 You may set `org-protocol-warn-about-old-links' to nil to surpress this message."))
 			       (funcall func result))))
 		    ;; Greedy protocol handlers are responsible for
 		    ;; parsing their own filenames.
-- 
2.13.1


  reply	other threads:[~2017-06-16 11:31 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-14 12:11 [PATCH] protocol: allow users to disable warning about old style links Alex Branham
2017-06-16  6:13 ` Nicolas Goaziou
2017-06-16 11:31   ` Alex Branham [this message]
2017-06-16 14:26     ` Nicolas Goaziou
2017-06-21 15:27   ` Tyler Smith
2017-06-21 16:01     ` Mario Martelli
2017-06-21 16:24       ` Tyler Smith
2017-06-21 16:34         ` Tyler Smith
2017-06-21 16:51         ` Mario Martelli
2017-06-21 17:09           ` Tyler Smith
2017-06-21 17:17             ` Mario Martelli

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=878tksb23w.fsf@utexas.edu \
    --to=branham@utexas.edu \
    --cc=emacs-orgmode@gnu.org \
    --cc=mail@nicolasgoaziou.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).