emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check
@ 2014-10-16 19:34 Kyle Meyer
  2014-10-16 20:25 ` Nicolas Goaziou
  0 siblings, 1 reply; 7+ messages in thread
From: Kyle Meyer @ 2014-10-16 19:34 UTC (permalink / raw)
  To: Org-mode

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

Hello,

A question on Stack Overflow [1] reported an issue overriding
`org-clock-into-drawer' with properties (specifically, overriding a
global value of t with a property value nil). Looking into the function
`org-clock-into-drawer', the actual behavior did not match the
documented behavior. The attached patch should fix the issue.

[1] http://stackoverflow.com/questions/26405415/how-to-locally-unset-org-clock-into-drawer-t


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-clock-Fix-CLOCK_INTO_DRAWER-property-check.patch --]
[-- Type: text/x-diff, Size: 1907 bytes --]

From c57cf41da1aab2e313d29dea64882d9808b8134a Mon Sep 17 00:00:00 2001
From: Kyle Meyer <kyle@kyleam.com>
Date: Thu, 16 Oct 2014 15:17:00 -0400
Subject: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check

* lisp/org-clock.el (org-clock-into-drawer): Fix processing of
properties so that they can override global value.

Previously, if the 'CLOCK_INTO_DRAWER' or 'LOG_INTO_DRAWER' property was
nil, the local property setting would not override the global
variable [1]. These changes make the behavior match the docstring
description ('CLOCK_INTO_DRAWER' and 'LOG_INTO_DRAWER' properties
override `org-clock-into-drawer', with 'CLOCK_INTO_DRAWER' given
precedence).

[1] http://stackoverflow.com/questions/26405415/how-to-locally-unset-org-clock-into-drawer-t

TINYCHANGE
---
 lisp/org-clock.el | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index 2ffcbfa..8fd7b89 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -74,13 +74,14 @@ (defun org-clock-into-drawer ()
 it will be used instead of the default value.
 The default is the value of the customizable variable `org-clock-into-drawer',
 which see."
-  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit))
-	(q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
+  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit t))
+        (q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
     (cond
-     ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
-     ((or (equal p "t") (equal q "t")) "LOGBOOK")
-     ((not p) q)
-     (t p))))
+     ((not (or p q)) org-clock-into-drawer)
+     ((equal p "nil") nil)
+     ((equal p "t") "LOGBOOK")
+     ((equal q "nil") nil)
+     ((equal q "t") "LOGBOOK"))))
 
 (defcustom org-clock-out-when-done t
   "When non-nil, clock will be stopped when the clocked entry is marked DONE.
-- 
2.1.2


[-- Attachment #3: Type: text/plain, Size: 10 bytes --]


-- 
Kyle

^ permalink raw reply related	[flat|nested] 7+ messages in thread

* Re: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check
  2014-10-16 19:34 [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check Kyle Meyer
@ 2014-10-16 20:25 ` Nicolas Goaziou
  2014-10-16 20:39   ` Kyle Meyer
  0 siblings, 1 reply; 7+ messages in thread
From: Nicolas Goaziou @ 2014-10-16 20:25 UTC (permalink / raw)
  To: Kyle Meyer; +Cc: Org-mode

Hello,

Kyle Meyer <kyle@kyleam.com> writes:

> A question on Stack Overflow [1] reported an issue overriding
> `org-clock-into-drawer' with properties (specifically, overriding a
> global value of t with a property value nil). Looking into the function
> `org-clock-into-drawer', the actual behavior did not match the
> documented behavior. The attached patch should fix the issue.

Thanks for the patch.

> -  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit))
> -	(q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
> +  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit t))
> +        (q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
>      (cond
> -     ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
> -     ((or (equal p "t") (equal q "t")) "LOGBOOK")
> -     ((not p) q)
> -     (t p))))
> +     ((not (or p q)) org-clock-into-drawer)
> +     ((equal p "nil") nil)
> +     ((equal p "t") "LOGBOOK")
> +     ((equal q "nil") nil)
> +     ((equal q "t") "LOGBOOK"))))

This is wrong.

If p is a string, e.g. "FOO", return value should be "FOO". Ditto if
q contains a string.


Regards,

-- 
Nicolas Goaziou

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check
  2014-10-16 20:25 ` Nicolas Goaziou
@ 2014-10-16 20:39   ` Kyle Meyer
  2014-10-16 20:51     ` Kyle Meyer
  0 siblings, 1 reply; 7+ messages in thread
From: Kyle Meyer @ 2014-10-16 20:39 UTC (permalink / raw)
  To: Nicolas Goaziou; +Cc: Org-mode

Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> This is wrong.
>
> If p is a string, e.g. "FOO", return value should be "FOO". Ditto if
> q contains a string.

Right. Thanks for pointing that out. I'll update the patch.

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check
  2014-10-16 20:39   ` Kyle Meyer
@ 2014-10-16 20:51     ` Kyle Meyer
  2014-10-16 21:01       ` Nicolas Goaziou
  0 siblings, 1 reply; 7+ messages in thread
From: Kyle Meyer @ 2014-10-16 20:51 UTC (permalink / raw)
  To: Nicolas Goaziou; +Cc: Org-mode

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

Kyle Meyer <kyle@kyleam.com> wrote:
> Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
>> This is wrong.
>>
>> If p is a string, e.g. "FOO", return value should be "FOO". Ditto if
>> q contains a string.
>
> Right. Thanks for pointing that out. I'll update the patch.

This new patch should handle that correctly.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-clock-Fix-CLOCK_INTO_DRAWER-property-check.patch --]
[-- Type: text/x-diff, Size: 1927 bytes --]

From 84799f9b9f4a2e89b3e717194352ef9a9d082de3 Mon Sep 17 00:00:00 2001
From: Kyle Meyer <kyle@kyleam.com>
Date: Thu, 16 Oct 2014 15:17:00 -0400
Subject: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check

* lisp/org-clock.el (org-clock-into-drawer): Fix processing of
properties so that they can override global value.

Previously, if the 'CLOCK_INTO_DRAWER' or 'LOG_INTO_DRAWER' property was
nil, the local property setting would not override the global
variable [1]. These changes make the behavior match the docstring
description ('CLOCK_INTO_DRAWER' and 'LOG_INTO_DRAWER' properties
override `org-clock-into-drawer', with 'CLOCK_INTO_DRAWER' given
precedence).

[1] http://stackoverflow.com/questions/26405415/how-to-locally-unset-org-clock-into-drawer-t

TINYCHANGE
---
 lisp/org-clock.el | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index 2ffcbfa..fbcda49 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -74,13 +74,15 @@ (defun org-clock-into-drawer ()
 it will be used instead of the default value.
 The default is the value of the customizable variable `org-clock-into-drawer',
 which see."
-  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit))
-	(q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
+  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit t))
+        (q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
     (cond
-     ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
-     ((or (equal p "t") (equal q "t")) "LOGBOOK")
-     ((not p) q)
-     (t p))))
+     ((not (or p q)) org-clock-into-drawer)
+     ((equal p "nil") nil)
+     ((equal p "t") "LOGBOOK")
+     ((equal q "nil") nil)
+     ((equal q "t") "LOGBOOK")
+     (t (or p q)))))
 
 (defcustom org-clock-out-when-done t
   "When non-nil, clock will be stopped when the clocked entry is marked DONE.
-- 
2.1.2


^ permalink raw reply related	[flat|nested] 7+ messages in thread

* Re: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check
  2014-10-16 20:51     ` Kyle Meyer
@ 2014-10-16 21:01       ` Nicolas Goaziou
  2014-10-16 21:20         ` Kyle Meyer
  0 siblings, 1 reply; 7+ messages in thread
From: Nicolas Goaziou @ 2014-10-16 21:01 UTC (permalink / raw)
  To: Kyle Meyer; +Cc: Org-mode

Kyle Meyer <kyle@kyleam.com> writes:

> This new patch should handle that correctly.

Thanks.

>      (cond
> -     ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
> -     ((or (equal p "t") (equal q "t")) "LOGBOOK")
> -     ((not p) q)
> -     (t p))))
> +     ((not (or p q)) org-clock-into-drawer)
> +     ((equal p "nil") nil)
> +     ((equal p "t") "LOGBOOK")
> +     ((equal q "nil") nil)
> +     ((equal q "t") "LOGBOOK")
> +     (t (or p q)))))

Actually, it doesn't work either. Under some circumstances (e.g, when
p is a drawer name and q is "t"), q will have precedence over p, which
is not desirable.

What about this?

  (cond ((equal p "nil") nil)
        ((equal p "t") t)
        (p)
        ((equal q "nil") nil)
        ((equal q "t") t)
        (q)
        (t org-clock-into-drawer))


Regards,

^ permalink raw reply	[flat|nested] 7+ messages in thread

* Re: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check
  2014-10-16 21:01       ` Nicolas Goaziou
@ 2014-10-16 21:20         ` Kyle Meyer
  2014-10-16 22:21           ` Nicolas Goaziou
  0 siblings, 1 reply; 7+ messages in thread
From: Kyle Meyer @ 2014-10-16 21:20 UTC (permalink / raw)
  To: Nicolas Goaziou; +Cc: Org-mode

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

Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Kyle Meyer <kyle@kyleam.com> writes:
> Actually, it doesn't work either. Under some circumstances (e.g, when
> p is a drawer name and q is "t"), q will have precedence over p, which
> is not desirable.

Good point.

> What about this?
>
>   (cond ((equal p "nil") nil)
>         ((equal p "t") t)
>         (p)
>         ((equal q "nil") nil)
>         ((equal q "t") t)
>         (q)
>         (t org-clock-into-drawer))

Nice. Thanks for fixing my fixes.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-clock-Fix-CLOCK_INTO_DRAWER-property-check.patch --]
[-- Type: text/x-diff, Size: 1936 bytes --]

From ac5c110cab56214d4bdf51b3ba52fc111794758f Mon Sep 17 00:00:00 2001
From: Kyle Meyer <kyle@kyleam.com>
Date: Thu, 16 Oct 2014 15:17:00 -0400
Subject: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check

* lisp/org-clock.el (org-clock-into-drawer): Fix processing of
properties so that they can override global value.

Previously, if the 'CLOCK_INTO_DRAWER' or 'LOG_INTO_DRAWER' property was
nil, the local property setting would not override the global
variable [1]. These changes make the behavior match the docstring
description ('CLOCK_INTO_DRAWER' and 'LOG_INTO_DRAWER' properties
override `org-clock-into-drawer', with 'CLOCK_INTO_DRAWER' given
precedence).

[1] http://stackoverflow.com/questions/26405415/how-to-locally-unset-org-clock-into-drawer-t

TINYCHANGE
---
 lisp/org-clock.el | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index 2ffcbfa..092a6aa 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -74,13 +74,15 @@ (defun org-clock-into-drawer ()
 it will be used instead of the default value.
 The default is the value of the customizable variable `org-clock-into-drawer',
 which see."
-  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit))
-	(q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
-    (cond
-     ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
-     ((or (equal p "t") (equal q "t")) "LOGBOOK")
-     ((not p) q)
-     (t p))))
+  (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit t))
+        (q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
+    (cond ((equal p "nil") nil)
+          ((equal p "t") t)
+          (p)
+          ((equal q "nil") nil)
+          ((equal q "t") t)
+          (q)
+          (t org-clock-into-drawer))))
 
 (defcustom org-clock-out-when-done t
   "When non-nil, clock will be stopped when the clocked entry is marked DONE.
-- 
2.1.2


^ permalink raw reply related	[flat|nested] 7+ messages in thread

* Re: [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check
  2014-10-16 21:20         ` Kyle Meyer
@ 2014-10-16 22:21           ` Nicolas Goaziou
  0 siblings, 0 replies; 7+ messages in thread
From: Nicolas Goaziou @ 2014-10-16 22:21 UTC (permalink / raw)
  To: Kyle Meyer; +Cc: Org-mode

Kyle Meyer <kyle@kyleam.com> writes:

> Nice. Thanks for fixing my fixes.

Patch applied. Thank you.


Regards,

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2014-10-16 22:20 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-10-16 19:34 [PATCH] org-clock: Fix CLOCK_INTO_DRAWER property check Kyle Meyer
2014-10-16 20:25 ` Nicolas Goaziou
2014-10-16 20:39   ` Kyle Meyer
2014-10-16 20:51     ` Kyle Meyer
2014-10-16 21:01       ` Nicolas Goaziou
2014-10-16 21:20         ` Kyle Meyer
2014-10-16 22:21           ` Nicolas Goaziou

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).