GNU bug report logs - #71592
[PATCH 0/3] gnu: emacs-org: Update to 9.7.4.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 71592 in the body.
You can then email your comments to 71592 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: Guix-patches mailing list <guix-patches <at> gnu.org>
Subject: [PATCH 0/3] gnu: emacs-org: Update to 9.7.4.
Date: Sun, 16 Jun 2024 10:36:46 -0400

Dear Guix,

This patch series updates Emacs' Org mode to 9.7.4.  It, additionally,
also updates some other packages that depend on Org mode so that their
build succeeds.

Hope to see this merged into Guix soon.™

Suhail (3):
  gnu: emacs-org: Update to 9.7.4.
  gnu: emacs-org-super-agenda: Ignore failing tests.
  gnu: emacs-compat: Build from git.

 gnu/packages/emacs-xyz.scm | 35 ++++++++++++++++++++++++-----------
 1 file changed, 24 insertions(+), 11 deletions(-)


base-commit: 2195f70936b7aeec123d4e95345f1007d3a7bb06
-- 
2.45.2

Message #8 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH 2/3] gnu: emacs-org-super-agenda: Ignore failing tests.
Date: Sun, 16 Jun 2024 11:30:52 -0400

* gnu/packages/emacs-xyz.scm (emacs-org-super-agenda): Ignore tests that fail
with emacs-org 9.7.4.

Change-Id: I06c3ec4a6b279b3cbf2efc392dc930b088f2b569
---
 gnu/packages/emacs-xyz.scm | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 9a57a0fbf7..cf0488d5c7 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -23608,8 +23608,16 @@ (define-public emacs-org-super-agenda
                  (string-append (getcwd) "/test/results.el")))
               ;; The following tests fail.
               (substitute* "test/test.el"
-                ((".* org-super-agenda-test--with-retained-sorting .*" all)
-                 (string-append all "  (skip-unless nil)\n"))))))))
+                  ((".* org-super-agenda-test--auto-parent .*" all)
+                   (string-append all "  (skip-unless nil)\n"))
+                  ;; some tests are using an obsolete variable
+                  (("\\(org-super-agenda-retain-sorting ")
+                   "(org-super-agenda-keep-order ")
+                  ;; however, they still fail ...
+                  ((".* org-super-agenda-test--with-retained-sorting .*" all)
+                   (string-append all "  (skip-unless nil)\n"))
+                  ((".* org-super-agenda-test--without-retained-sorting .*" all)
+                   (string-append all "  (skip-unless nil)\n"))))))))
     (native-inputs
      (list emacs-f util-linux))
     (propagated-inputs
-- 
2.45.2

Message #11 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH 3/3] gnu: emacs-compat: Build from git.
Date: Sun, 16 Jun 2024 11:31:52 -0400

* gnu/packages/emacs-xyz.scm (emacs-compat): The hash on ELPA no longer
matches the one noted in Guix.  Update it to use the git repository and update
the home-page as well.

Change-Id: I0c9cb62be365e87cb4da1847272743bb4206197c
---
 gnu/packages/emacs-xyz.scm | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index cf0488d5c7..8e7a0a0b5c 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -9477,14 +9477,15 @@ (define-public emacs-compat
     (name "emacs-compat")
     (version "29.1.4.5")
     (source (origin
-              (method url-fetch)
-              (uri (string-append "https://elpa.gnu.org/packages/"
-                                  "compat-" version ".tar"))
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/emacs-compat/compat")
+                    (commit version)))
               (sha256
                (base32
-                "191cjzrw9xm5bvcf8s1yr9hdcn9i02789xfd8pz33lk65s0rq413"))))
+                "1bq2nk052g5ydl6qgiiiflnamzn1lgikv6yc8ijfzwksg06wq959"))))
     (build-system emacs-build-system)
-    (home-page "https://git.sr.ht/~pkal/compat")
+    (home-page "https://github.com/emacs-compat/compat")
     (synopsis "Emacs Lisp Compatibility Library")
     (description
      "To allow for the usage of Emacs functions and macros that are defined
-- 
2.45.2

Message #14 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH 1/3] gnu: emacs-org: Update to 9.7.4.
Date: Sun, 16 Jun 2024 11:29:25 -0400

* gnu/packages/emacs-xyz.scm (emacs-org): Update to 9.7.4.

Change-Id: Iec5f62a5d4a8c23f939aef118473b81a2dc9122b
---
 gnu/packages/emacs-xyz.scm | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index da4a2340fe..9a57a0fbf7 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -17118,7 +17118,7 @@ (define-public emacs-neotree
 (define-public emacs-org
   (package
     (name "emacs-org")
-    (version "9.6.30")
+    (version "9.7.4")
     (source
      (origin
        (method git-fetch)
@@ -17127,7 +17127,7 @@ (define-public emacs-org
              (commit (string-append "release_" version))))
        (file-name (git-file-name name version))
        (sha256
-        (base32 "0v4b3yl4limrq3jgf0jvvx73cs7d36p14c2x93pdvn50mjykii3f"))))
+        (base32 "00crs2q4yvmv2jgzmcfyl2g6m7g42zpggyssmcj8anwrsp748z9b"))))
     (build-system emacs-build-system)
     (arguments
      (list
@@ -17156,8 +17156,7 @@ (define-public emacs-org
                 (for-each make-file-writable
                           '("babel.org"
                             "ob-awk-test.org"
-                            "ob-sed-test.org"
-                            "ob-shell-test.org"))
+                            "ob-sed-test.org"))
                 ;; Specify where sh executable is.
                 (let ((sh (search-input-file inputs "/bin/sh")))
                   (substitute* "babel.org"
@@ -17166,6 +17165,11 @@ (define-public emacs-org
               (substitute* "testing/lisp/test-ob-shell.el"
                 (("ob-shell/remote-with-stdin-or-cmdline .*" all)
                  (string-append all "  (skip-unless nil)\n")))
+              ;; XXX: ob-tangle/collect-blocks fails because the test assumes
+              ;; that ~/../.. corresponds to /.  This isn't true in our case.
+              (substitute* "testing/lisp/test-ob-tangle.el"
+                (("ob-tangle/collect-blocks .*" all)
+                 (string-append all "  (skip-unless nil)\n")))
               (substitute* "testing/lisp/test-org.el"
                 (("test-org/org-(encode-time|time-string-to-time) .*" all)
                  (string-append all "  (skip-unless nil)\n")))))
-- 
2.45.2

Message #17 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
To: Suhail Singh <suhailsingh247 <at> gmail.com>, 71592 <at> debbugs.gnu.org
Cc: Katherine Cox-Buday <cox.katherine.e+guix <at> gmail.com>,
 Andrew Tropin <andrew <at> trop.in>
Subject: Re: [bug#71592] [PATCH 2/3] gnu: emacs-org-super-agenda: Ignore
 failing tests.
Date: Sun, 16 Jun 2024 17:53:30 +0200

Am Sonntag, dem 16.06.2024 um 11:30 -0400 schrieb Suhail Singh:
> 
> * gnu/packages/emacs-xyz.scm (emacs-org-super-agenda): Ignore tests
> that fail
> with emacs-org 9.7.4.
> 
> Change-Id: I06c3ec4a6b279b3cbf2efc392dc930b088f2b569
> ---
>  gnu/packages/emacs-xyz.scm | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
> index 9a57a0fbf7..cf0488d5c7 100644
> --- a/gnu/packages/emacs-xyz.scm
> +++ b/gnu/packages/emacs-xyz.scm
> @@ -23608,8 +23608,16 @@ (define-public emacs-org-super-agenda
>                   (string-append (getcwd) "/test/results.el")))
>                ;; The following tests fail.
>                (substitute* "test/test.el"
> -                ((".* org-super-agenda-test--with-retained-sorting
> .*" all)
> -                 (string-append all "  (skip-unless nil)\n"))))))))
> +                  ((".* org-super-agenda-test--auto-parent .*" all)
> +                   (string-append all "  (skip-unless nil)\n"))
> +                  ;; some tests are using an obsolete variable
> +                  (("\\(org-super-agenda-retain-sorting ")
> +                   "(org-super-agenda-keep-order ")
> +                  ;; however, they still fail ...
> +                  ((".* org-super-agenda-test--with-retained-sorting
> .*" all)
> +                   (string-append all "  (skip-unless nil)\n"))
> +                  ((".* org-super-agenda-test--without-retained-
> sorting .*" all)
> +                   (string-append all "  (skip-unless
> nil)\n"))))))))
I think a comment here noting the incompatibility would be nice.
Perhaps marked as a TODO, so that updaters know to remove it.

Cheers

Message #20 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
To: Suhail Singh <suhailsingh247 <at> gmail.com>, 71592 <at> debbugs.gnu.org
Cc: Katherine Cox-Buday <cox.katherine.e+guix <at> gmail.com>,
 Andrew Tropin <andrew <at> trop.in>
Subject: Re: [bug#71592] [PATCH 3/3] gnu: emacs-compat: Build from git.
Date: Sun, 16 Jun 2024 17:55:21 +0200

Am Sonntag, dem 16.06.2024 um 11:31 -0400 schrieb Suhail Singh:
> 
> * gnu/packages/emacs-xyz.scm (emacs-compat): The hash on ELPA no
> longer matches the one noted in Guix.  Update it to use the git
> repository and update the home-page as well.
Mark [source] and [home-page] updates individually.

Building from git SGTM, but do we know that those tags are sane?  If
not, I'd go to git-version instead.


Cheers

Message #23 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH v2 0/4] gnu: emacs-org: Update to 9.7.4.
Date: Mon, 17 Jun 2024 07:59:10 -0400

Dear Guix,

This patch series updates Emacs' Org mode to 9.7.4.  It, additionally,
also updates some other packages that depend on Org mode so that their
build succeeds.

Hope to see this merged into Guix soon.™


Suhail (4):
  gnu: emacs-org: Update to 9.7.4.
  gnu: emacs-org-super-agenda: Ignore failing tests.
  gnu: emacs-compat: Update the home-page.
  gnu: emacs-compat: Update source to use git reference.

 gnu/packages/emacs-xyz.scm | 46 ++++++++++++++++++++++++++++++--------
 1 file changed, 37 insertions(+), 9 deletions(-)


base-commit: 2195f70936b7aeec123d4e95345f1007d3a7bb06
-- 
2.45.2

Message #26 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH v2 1/4] gnu: emacs-org: Update to 9.7.4.
Date: Mon, 17 Jun 2024 08:00:26 -0400

* gnu/packages/emacs-xyz.scm (emacs-org): Update to 9.7.4.

Change-Id: Iec5f62a5d4a8c23f939aef118473b81a2dc9122b
---
 gnu/packages/emacs-xyz.scm | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index da4a2340fe..307950aacd 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -17118,7 +17118,7 @@ (define-public emacs-neotree
 (define-public emacs-org
   (package
     (name "emacs-org")
-    (version "9.6.30")
+    (version "9.7.4")
     (source
      (origin
        (method git-fetch)
@@ -17127,7 +17127,7 @@ (define-public emacs-org
              (commit (string-append "release_" version))))
        (file-name (git-file-name name version))
        (sha256
-        (base32 "0v4b3yl4limrq3jgf0jvvx73cs7d36p14c2x93pdvn50mjykii3f"))))
+        (base32 "00crs2q4yvmv2jgzmcfyl2g6m7g42zpggyssmcj8anwrsp748z9b"))))
     (build-system emacs-build-system)
     (arguments
      (list
@@ -17156,12 +17156,25 @@ (define-public emacs-org
                 (for-each make-file-writable
                           '("babel.org"
                             "ob-awk-test.org"
-                            "ob-sed-test.org"
-                            "ob-shell-test.org"))
+                            "ob-sed-test.org"))
                 ;; Specify where sh executable is.
                 (let ((sh (search-input-file inputs "/bin/sh")))
                   (substitute* "babel.org"
                     (("/bin/sh") sh))))
+              ;; XXX: Fix failure in ob-tangle/collect-blocks.  The test
+              ;; assumes that ~/../.. corresponds to /.  This isn't true in
+              ;; our case.
+              (substitute* "testing/lisp/test-ob-tangle.el"
+                ((" ~/\\.\\./\\.\\./")
+                 (string-append " ~"
+                                ;; relative path from ${HOME} to / during
+                                ;; build
+                                (string-join
+                                 (map-in-order
+                                  (lambda (x)
+                                    (if (equal? x "") "" ".."))
+                                  (string-split (getcwd) #\/)) "/")
+                                "/")))
               ;; XXX: Skip failing tests.
               (substitute* "testing/lisp/test-ob-shell.el"
                 (("ob-shell/remote-with-stdin-or-cmdline .*" all)
-- 
2.45.2

Message #29 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH v2 2/4] gnu: emacs-org-super-agenda: Ignore failing tests.
Date: Mon, 17 Jun 2024 08:01:09 -0400

* gnu/packages/emacs-xyz.scm (emacs-org-super-agenda): Ignore tests that fail
with emacs-org 9.7.4.

Change-Id: I06c3ec4a6b279b3cbf2efc392dc930b088f2b569
---
 gnu/packages/emacs-xyz.scm | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 307950aacd..536db8a43b 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -23617,7 +23617,21 @@ (define-public emacs-org-super-agenda
                  (string-append (getcwd) "/test/results.el")))
               ;; The following tests fail.
               (substitute* "test/test.el"
+                ;; TODO: Broken on emacs-org-super-agenda <at> 1.3 and
+                ;; emacs-org <at> 9.7.4.  Verify when updating.
+                ((".* org-super-agenda-test--auto-parent .*" all)
+                 (string-append all "  (skip-unless nil)\n"))
+                ;; Some tests are using an obsolete variable; fix its use.
+                (("\\(org-super-agenda-retain-sorting ")
+                 "(org-super-agenda-keep-order ")
+                ;; however, they still fail ...
+                ;; TODO: Broken on emacs-org-super-agenda <at> 1.3 since before
+                ;; emacs-org <at> 9.7.4.  Verify when updating.
                 ((".* org-super-agenda-test--with-retained-sorting .*" all)
+                 (string-append all "  (skip-unless nil)\n"))
+                ;; TODO: Broken on emacs-org-super-agenda <at> 1.3 and
+                ;; emacs-org <at> 9.7.4.  Verify when updating.
+                ((".* org-super-agenda-test--without-retained-sorting .*" all)
                  (string-append all "  (skip-unless nil)\n"))))))))
     (native-inputs
      (list emacs-f util-linux))
-- 
2.45.2

Message #32 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH v2 3/4] gnu: emacs-compat: Update the home-page.
Date: Mon, 17 Jun 2024 08:02:25 -0400

* gnu/packages/emacs-xyz.scm (emacs-compat): Fix the broken home-page.

Change-Id: I47a81edd1e99a2335e2df7533654f799b9a20cd2
---
 gnu/packages/emacs-xyz.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 536db8a43b..353ccaa3b8 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -9484,7 +9484,7 @@ (define-public emacs-compat
                (base32
                 "191cjzrw9xm5bvcf8s1yr9hdcn9i02789xfd8pz33lk65s0rq413"))))
     (build-system emacs-build-system)
-    (home-page "https://git.sr.ht/~pkal/compat")
+    (home-page "https://elpa.gnu.org/packages/compat.html")
     (synopsis "Emacs Lisp Compatibility Library")
     (description
      "To allow for the usage of Emacs functions and macros that are defined
-- 
2.45.2

Message #35 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 71592 <at> debbugs.gnu.org
Subject: [PATCH v2 4/4] gnu: emacs-compat: Update source to use git reference.
Date: Mon, 17 Jun 2024 08:03:08 -0400

* gnu/packages/emacs-xyz.scm (emacs-compat): The hash on ELPA no longer
matches the one noted in Guix.  Update it to use the git repository.

Change-Id: I0c9cb62be365e87cb4da1847272743bb4206197c
---
 gnu/packages/emacs-xyz.scm | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 353ccaa3b8..21de60c060 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -9477,12 +9477,13 @@ (define-public emacs-compat
     (name "emacs-compat")
     (version "29.1.4.5")
     (source (origin
-              (method url-fetch)
-              (uri (string-append "https://elpa.gnu.org/packages/"
-                                  "compat-" version ".tar"))
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/emacs-compat/compat")
+                    (commit version)))
               (sha256
                (base32
-                "191cjzrw9xm5bvcf8s1yr9hdcn9i02789xfd8pz33lk65s0rq413"))))
+                "1bq2nk052g5ydl6qgiiiflnamzn1lgikv6yc8ijfzwksg06wq959"))))
     (build-system emacs-build-system)
     (home-page "https://elpa.gnu.org/packages/compat.html")
     (synopsis "Emacs Lisp Compatibility Library")
-- 
2.45.2

Message #40 received at 71592-done <at> debbugs.gnu.org (full text, mbox):

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: "Suhail Singh" <suhailsingh247 <at> gmail.com>
Cc: Liliana Marie Prikler <liliana.prikler <at> gmail.com>,
 Katherine Cox-Buday <cox.katherine.e+guix <at> gmail.com>,
 71592-done <at> debbugs.gnu.org, Andrew Tropin <andrew <at> trop.in>
Subject: Re: [bug#71592] [PATCH v2 0/4] gnu: emacs-org: Update to 9.7.4.
Date: Wed, 19 Jun 2024 09:54:38 +0200

Hello,

"Suhail Singh" <suhailsingh247 <at> gmail.com> writes:

> This patch series updates Emacs' Org mode to 9.7.4.  It, additionally,
> also updates some other packages that depend on Org mode so that their
> build succeeds.

Applied. Thank you.

Regards,
-- 
Nicolas Goaziou

Message #43 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: Adam Porter <adam <at> alphapapa.net>
To: 71592 <at> debbugs.gnu.org, Suhail Singh <suhailsingh247 <at> gmail.com>
Subject: [PATCH 0/3] gnu: emacs-org: Update to 9.7.4.
Date: Sat, 22 Jun 2024 16:39:49 -0500

Hello,

I'm the author of org-super-agenda, some of whose tests have been 
bypassed in this patch series.

Suhail, I appreciate your making the package build on Guix, but have 
these failing tests been reported as bugs upstream?  You mention in a 
code comment an obsolete variable, but I don't know anything about that, 
and I can't find a bug reported on the tracker about it.

Please, if you know about a bug, and especially if you know about a 
solution, report it upstream so it can be fixed.  I maintain a number of 
Emacs/Org packages, and keeping up with the changes in Org, and trying 
to maintain compatibility across versions which have incompatibilities, 
is trying, especially if users don't report them (I don't always run the 
latest release of Org).

Thanks,
Adam

Message #46 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: Suhail Singh <suhailsingh247 <at> gmail.com>
To: Adam Porter <adam <at> alphapapa.net>
Cc: 71592 <at> debbugs.gnu.org, Suhail Singh <suhailsingh247 <at> gmail.com>
Subject: Re: [PATCH 0/3] gnu: emacs-org: Update to 9.7.4.
Date: Sun, 23 Jun 2024 01:27:01 -0400

Adam Porter <adam <at> alphapapa.net> writes:

> Suhail, I appreciate your making the package build on Guix,

Hello, Adam.  Though I am not a user, I appreciate you authoring the
package and releasing and supporting it for the benefit of others.

> but have these failing tests been reported as bugs upstream?

I have not made any bug reports regarding the failing tests yet.  I
don't know if others have (or rather didn't, before I started writing
this email).  I did try and see if a newer commit from org-super-agenda
was immune from the test failures, but didn't have any luck.

It's not clear to me whether the test failures point to bug(s) in
org-super-agenda, bug(s) in its test suite, bug(s) in Org mode, or (less
likely, but still possible) false positive(s) arising due to the tests
not being designed necessarily to run on Guix.  I was planning to look
into it further, but since I don't personally use org-super-agenda it's
not been a priority.  Regardless, for the benefit of others, I am glad
that you pay attention to this mailing list and are now aware.

> You mention in a code comment an obsolete variable, but I don't know
> anything about that, and I can't find a bug reported on the tracker
> about it.

The "obsolete" variable in question is
`org-super-agenda-retain-sorting'.  The tests making use of the older
user option are `org-super-agenda-test--with-retained-sorting' and
`org-super-agenda-test--without-retained-sorting'.  In commit
`27aa0db4243b835494f4836b82d0fbf3c5be7392' on 2021-09-28, it seems you
renamed that option to `org-super-agenda-keep-order'.  The tests were
not updated.  The FIXME comment in the former test notes:

#+begin_src emacs-lisp
  ;; FIXME: This seems to be slightly broken on Org 9.6.6.  Maybe <https://github.com/alphapapa/org-super-agenda/issues/207>?
#+end_src

The bug #207 seems to have been first noted about 3 years ago, is
currently open and assigned to you, and targeted for the 1.4 milestone.

> Please, if you know about a bug,

Not being a user of the package, my awareness is limited to the presence
of test failures.  I am not sure if you have CI configured for the
project, but if you have and aren't seeing these failures, it may be
worth your while to understand where those differences stem from.  If
you do and do see the same failures, your awareness and understanding of
the issues probably exceeds my own limited understanding, so please
excuse most of this email.  If you don't have CI configured, you may
want to consider doing so.

Whether these failures are false positives or not, is not clear to me.
If I had spent more time analyzing it, I am sure eventually I would have
understood it and either added to the existing issues, or opened new
ones, or submitted one or more patch/pull request upstream.  Alas,
there's only so much time in the day and we must all prioritize.

> and especially if you know about a solution,

As noted in my patch, my attempt to naively rename
`org-super-agenda-retain-sorting' to `org-super-agenda-keep-order' did
not fix the failures I observed.  The actual fix, whatever it is, isn't
one I'm aware of.

> report it upstream so it can be fixed.

That _is_ the general protcol ;)

> I maintain a number of Emacs/Org packages, and keeping up with the
> changes in Org, and trying to maintain compatibility across versions
> which have incompatibilities, is trying, especially if users don't
> report them (I don't always run the latest release of Org).

I agree user reports are invaluable.  In fact, I'd go further and say
that user time is invaluable.  However, given that their time is
precious, it seems wasteful to rely on them for something that can be
adequately addressed by a properly configured CI system (at least in
this instance).  In my candid opinion, their time is better served
reporting on usability concerns that aren't (yet) covered by tests.

Regards,
-- 
Suhail

Message #49 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: Adam Porter <adam <at> alphapapa.net>
To: Suhail Singh <suhailsingh247 <at> gmail.com>
Cc: 71592 <at> debbugs.gnu.org
Subject: Re: [PATCH 0/3] gnu: emacs-org: Update to 9.7.4.
Date: Thu, 27 Jun 2024 08:40:49 -0500

Hi Suhail,

On 6/23/24 00:27, Suhail Singh wrote:
> 
>> but have these failing tests been reported as bugs upstream?
> 
> I have not made any bug reports regarding the failing tests yet.  I 
> don't know if others have (or rather didn't, before I started
> writing this email).  I did try and see if a newer commit from 
> org-super-agenda was immune from the test failures, but didn't have 
> any luck.
> 
> It's not clear to me whether the test failures point to bug(s) in 
> org-super-agenda, bug(s) in its test suite, bug(s) in Org mode, or 
> (less likely, but still possible) false positive(s) arising due to 
> the tests not being designed necessarily to run on Guix.  I was 
> planning to look into it further, but since I don't personally use 
> org-super-agenda it's not been a priority.  Regardless, for the 
> benefit of others, I am glad that you pay attention to this mailing 
> list and are now aware.

I don't subscribe to nor watch the Guix lists; I don't have enough
personal bandwidth for that.  I only noticed this report because I was
trying to understand a problem with building Emacs 29.4 and was looking
for related issues on the tracker.

>> You mention in a code comment an obsolete variable, but I don't 
>> know anything about that, and I can't find a bug reported on the 
>> tracker about it.
> 
> The "obsolete" variable in question is 
> `org-super-agenda-retain-sorting'.  The tests making use of the
> older user option are `org-super-agenda-test--with-retained-sorting'
> and `org-super-agenda-test--without-retained-sorting'.  In commit 
> `27aa0db4243b835494f4836b82d0fbf3c5be7392' on 2021-09-28, it seems 
> you renamed that option to `org-super-agenda-keep-order'.  The tests
>  were not updated.  The FIXME comment in the former test notes:
> 
> #+begin_src emacs-lisp ;; FIXME: This seems to be slightly broken on
>  Org 9.6.6.  Maybe 
> <https://github.com/alphapapa/org-super-agenda/issues/207>? 
> #+end_src
> 
> The bug #207 seems to have been first noted about 3 years ago, is 
> currently open and assigned to you, and targeted for the 1.4 
> milestone.

Thanks for your thorough investigation.  The problem you've described is
simply that, when I renamed a symbol in a contributor's code before
merging it, I overlooked to rename it in the associated test as
well--and this is the first I've heard about it.  The issue mentioned in
the FIXME is related to the functionality, but is not about the test
itself, and the test does not appear to fail there due to the incorrect
symbol (IOW the test would fail anyway due to the "real" problem).

>> Please, if you know about a bug,
> 
> Not being a user of the package, my awareness is limited to the 
> presence of test failures.  I am not sure if you have CI configured 
> for the project, but if you have and aren't seeing these failures, it
> may be worth your while to understand where those differences stem
> from.  If you do and do see the same failures, your awareness and
> understanding of the issues probably exceeds my own limited 
> understanding, so please excuse most of this email.  If you don't 
> have CI configured, you may want to consider doing so.

>> I maintain a number of Emacs/Org packages, and keeping up with the 
>> changes in Org, and trying to maintain compatibility across 
>> versions which have incompatibilities, is trying, especially if 
>> users don't report them (I don't always run the latest release of 
>> Org).
> 
> I agree user reports are invaluable.  In fact, I'd go further and
> say that user time is invaluable.  However, given that their time is
>  precious, it seems wasteful to rely on them for something that can
> be adequately addressed by a properly configured CI system (at least
> in this instance).  In my candid opinion, their time is better
> served reporting on usability concerns that aren't (yet) covered by
> tests.

As you can see in the respective git repositories, there are extensive
lints and tests, and they are run on GitHub CI using my bespoke makem.sh
system for linting and testing Emacs Lisp packages, across a variety of
Emacs versions.  I also use this system extensively to test changes
locally before pushing, and I have for years (the whole reason I wrote
makem.sh 5 years ago, because catching these kinds of problems after the
fact is utterly impractical to deal with).

Nevertheless, due to the fact that multiple versions of Emacs and of Org
are supported by these packages, it is not always possible for the lints
and tests to pass cleanly on all supported versions at the same
time--and that can cause actual problems, such as this test having a
wrong symbol name, to be obscured, which appears to be the case here.

IOW, for some projects, the lints and/or tests are always going to fail
on some combination of Emacs/Org versions, even though the project in
question may actually work on it.  So a "properly configured CI system"
is not a panacea; software being software, there will always be holes in
the various layers, and when they align...

> Whether these failures are false positives or not, is not clear to 
> me. If I had spent more time analyzing it, I am sure eventually I 
> would have understood it and either added to the existing issues, or
>  opened new ones, or submitted one or more patch/pull request 
> upstream.  Alas, there's only so much time in the day and we must all
> prioritize.

All I ask is that, if you know about an obvious problem like a symbol
name being wrong, that you drop me a line, either as an issue on the
tracker or via email.

When you mentioned an "obsolete symbol," I thought you meant one defined
in Org itself (because, strictly speaking, the symbol in
org-super-agenda was never in a released version, having been renamed
before it was even merged, so it was not "obsolete", a term that has a
specific meaning, especially in Emacs-related contexts; and Org itself
frequently obsoletes symbols across versions).  So I was wondering what
new Org symbol I needed to add compatibility code for in org-super-agenda.

>> and especially if you know about a solution,
> 
> As noted in my patch, my attempt to naively rename 
> `org-super-agenda-retain-sorting' to `org-super-agenda-keep-order' 
> did not fix the failures I observed.  The actual fix, whatever it is,
> isn't one I'm aware of.

That would be issue #207, and it appears to be one of those things that
changes across Org versions, making it hard or impossible to fix in a
way that comprehensively passes testing (especially since I've no
control over the versions of Emacs and Org used in Guix).  It's also a
minor bug, essentially a cosmetic issue, which has made it a low
priority to work on with my limited time, which I'm sure you can appreciate.

Anyway, as a longtime user of and contributor to distributions that
package upstream software for downstream users, such as Debian and Guix,
I appreciate the role of the "middleman" packager/maintainer.  Also
being an upstream maintainer, I appreciate the challenge from that
perspective as well.  The best way to smooth over these issues is to
have good communication in both directions.

So as an upstream developer, I try to make changes small, atomic, and
well-documented, and to make bug-fix releases on stable branches, to
make it easier for downstream maintainers to incorporate such changes
between major releases.

My only request as such an upstream maintainer is that, when a
downstream maintainer finds a problem, that it be reported to me,
especially when it may indicate an underlying bug rather than a
downstream compatibility issue (e.g. one specific to Guix; but note that
I'm keen to help compatibility with Guix as well).

Thanks,
Adam

Message #52 received at 71592 <at> debbugs.gnu.org (full text, mbox):

From: Suhail Singh <suhailsingh247 <at> gmail.com>
To: Adam Porter <adam <at> alphapapa.net>
Cc: 71592 <at> debbugs.gnu.org, Suhail Singh <suhailsingh247 <at> gmail.com>
Subject: Re: [PATCH 0/3] gnu: emacs-org: Update to 9.7.4.
Date: Thu, 27 Jun 2024 20:04:21 -0400

Adam Porter <adam <at> alphapapa.net> writes:

> IOW, for some projects, the lints and/or tests are always going to fail
> on some combination of Emacs/Org versions, even though the project in
> question may actually work on it.

That's understandable.  When I encounter such situations, I find it
helpful to separate tests where "failure is intolerable" from others
where "failure, while not ideal, is acceptable".  You may find it
helpful to make such a distinction as well.

> That would be issue #207, and it appears to be one of those things
> that changes across Org versions, making it hard or impossible to fix
> in a way that comprehensively passes testing (especially since I've no
> control over the versions of Emacs and Org used in Guix).  It's also a
> minor bug, essentially a cosmetic issue, which has made it a low
> priority to work on with my limited time, which I'm sure you can
> appreciate.

It seems that #207 isn't one that will be fixed in the near future and
that that's acceptable (for users of org-super-agenda).  It's unclear
whether the failure in test `org-super-agenda-test--auto-parent' also
corresponds to the same bug, or a distinct issue.  Regardless, if one or
more of the failing tests are acceptable failures, it would help Guix
packagers if upstream was updated to provide a command/invocation that
does not fail when such category of tests don't succeed.  It would
obviate having to ignore such failing tests in Guix and reduce the
maintenance burden of downstream packagers.

-- 
Suhail

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.