From: "Kévin Le Gouguec" <kevin.legouguec@gmail.com>
To: Bastien <bzg@gnu.org>
Cc: emacs-orgmode@gnu.org
Subject: Re: [POLL] Setting `org-adapt-indentation' to nil by default?
Date: Sun, 09 May 2021 18:42:22 +0200 [thread overview]
Message-ID: <871raf270x.fsf@gmail.com> (raw)
In-Reply-To: <875yzwlzlc.fsf@gnu.org> (Bastien's message of "Thu, 06 May 2021 16:13:35 +0200")
[-- Attachment #1: Type: text/plain, Size: 676 bytes --]
Bastien <bzg@gnu.org> writes:
>> It is now, as of commit 0a651b746.
>
> ... and I broke some tests. Sorry for that. I will fix this next
> week, unless someone does it before me.
Here are two patches that set org-adapt-indentation to t for the tests
which were implicitly relying on that behavior; that lets 'make test'
succeed again for me.
I'm pretty sure the first one is TRT (since I'm the author of the
tests), although Eventually™ we should make a more exhaustive suite
based on the table you referenced earlier.
The second one makes the remaining tests pass again, but I couldn't tell
at a glance whether their expectations still make sense.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Set-org-adapt-indentation-explicitly-in-some-tests.patch --]
[-- Type: text/x-patch, Size: 3006 bytes --]
From e136f0d3123173d947bf4c1ce06aaf5f12117ef8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=A9vin=20Le=20Gouguec?= <kevin.legouguec@gmail.com>
Date: Sun, 9 May 2021 18:05:35 +0200
Subject: [PATCH 1/2] Set org-adapt-indentation explicitly in some tests
* testing/lisp/test-org.el (test-org/with-electric-indent,
test-org/without-electric-indent): Make sure org-adapt-indentation is
consistent with expected results.
---
testing/lisp/test-org.el | 42 +++++++++++++++++++++++-----------------
1 file changed, 24 insertions(+), 18 deletions(-)
diff --git a/testing/lisp/test-org.el b/testing/lisp/test-org.el
index 9f0ede1b9..5ac9173ac 100644
--- a/testing/lisp/test-org.el
+++ b/testing/lisp/test-org.el
@@ -1404,12 +1404,14 @@
(electric-indent-local-mode 1)
(call-interactively 'org-return)
(buffer-string))))
- (should
- (equal "* heading\n body"
- (org-test-with-temp-text "* heading<point>body"
- (electric-indent-local-mode 1)
- (call-interactively 'org-return)
- (buffer-string))))
+ ;; TODO: test more values of `org-adapt-indentation'.
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "* heading\n body"
+ (org-test-with-temp-text "* heading<point>body"
+ (electric-indent-local-mode 1)
+ (call-interactively 'org-return)
+ (buffer-string)))))
;; C-j, like `electric-newline-and-maybe-indent', should not indent.
(should
(equal " Para\ngraph"
@@ -1423,12 +1425,14 @@
(electric-indent-local-mode 1)
(call-interactively 'org-return-and-maybe-indent)
(buffer-string))))
- (should
- (equal "* heading\nbody"
- (org-test-with-temp-text "* heading<point>body"
- (electric-indent-local-mode 1)
- (call-interactively 'org-return-and-maybe-indent)
- (buffer-string)))))
+ ;; TODO: test more values of `org-adapt-indentation'.
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "* heading\nbody"
+ (org-test-with-temp-text "* heading<point>body"
+ (electric-indent-local-mode 1)
+ (call-interactively 'org-return-and-maybe-indent)
+ (buffer-string))))))
(ert-deftest test-org/without-electric-indent ()
"Test RET and C-j specifications with `electric-indent-mode' off."
@@ -1467,12 +1471,14 @@
(electric-indent-local-mode 0)
(call-interactively 'org-return-and-maybe-indent)
(buffer-string))))
- (should
- (equal "* heading\n body"
- (org-test-with-temp-text "* heading<point>body"
- (electric-indent-local-mode 0)
- (call-interactively 'org-return-and-maybe-indent)
- (buffer-string)))))
+ ;; TODO: test more values of `org-adapt-indentation'.
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "* heading\n body"
+ (org-test-with-temp-text "* heading<point>body"
+ (electric-indent-local-mode 0)
+ (call-interactively 'org-return-and-maybe-indent)
+ (buffer-string))))))
(ert-deftest test-org/meta-return ()
"Test M-RET (`org-meta-return') specifications."
--
2.31.1
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-Set-org-adapt-indentation-explicitly-in-some-tests.patch --]
[-- Type: text/x-patch, Size: 7038 bytes --]
From 2a485754a7f04d00ef5e5ebed82924d44f768424 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=A9vin=20Le=20Gouguec?= <kevin.legouguec@gmail.com>
Date: Sun, 9 May 2021 18:20:11 +0200
Subject: [PATCH 2/2] Set org-adapt-indentation explicitly in some tests
* testing/lisp/test-org.el (test-org/indent-line,
test-org/indent-region): Make sure org-adapt-indentation is consistent
with expected results.
---
testing/lisp/test-org.el | 126 ++++++++++++++++++++-------------------
1 file changed, 66 insertions(+), 60 deletions(-)
diff --git a/testing/lisp/test-org.el b/testing/lisp/test-org.el
index 5ac9173ac..95ffb0a80 100644
--- a/testing/lisp/test-org.el
+++ b/testing/lisp/test-org.el
@@ -1007,22 +1007,23 @@
;; At the first line of an element, indent like previous element's
;; first line, ignoring footnotes definitions and inline tasks, or
;; according to parent.
- (should
- (= 2
- (org-test-with-temp-text "A\n\n B\n\nC<point>"
- (org-indent-line)
- (org-get-indentation))))
- (should
- (= 1
- (org-test-with-temp-text " A\n\n[fn:1] B\n\n\nC<point>"
- (org-indent-line)
- (org-get-indentation))))
- (should
- (= 1
- (org-test-with-temp-text
- " #+BEGIN_CENTER\n<point> Contents\n#+END_CENTER"
- (org-indent-line)
- (org-get-indentation))))
+ (let ((org-adapt-indentation t))
+ (should
+ (= 2
+ (org-test-with-temp-text "A\n\n B\n\nC<point>"
+ (org-indent-line)
+ (org-get-indentation))))
+ (should
+ (= 1
+ (org-test-with-temp-text " A\n\n[fn:1] B\n\n\nC<point>"
+ (org-indent-line)
+ (org-get-indentation))))
+ (should
+ (= 1
+ (org-test-with-temp-text
+ " #+BEGIN_CENTER\n<point> Contents\n#+END_CENTER"
+ (org-indent-line)
+ (org-get-indentation)))))
;; Within code part of a source block, use language major mode if
;; `org-src-tab-acts-natively' is non-nil. Otherwise, indent
;; according to line above.
@@ -1066,11 +1067,12 @@
(ert-deftest test-org/indent-region ()
"Test `org-indent-region' specifications."
;; Indent paragraph.
- (should
- (equal "A\nB\nC"
- (org-test-with-temp-text " A\nB\n C"
- (org-indent-region (point-min) (point-max))
- (buffer-string))))
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "A\nB\nC"
+ (org-test-with-temp-text " A\nB\n C"
+ (org-indent-region (point-min) (point-max))
+ (buffer-string)))))
;; Indent greater elements along with their contents.
(should
(equal "#+BEGIN_CENTER\nA\nB\n#+END_CENTER"
@@ -1083,11 +1085,12 @@
(org-test-with-temp-text "#+BEGIN_VERSE\n A\n B\n#+END_VERSE"
(org-indent-region (point-min) (point-max))
(buffer-string))))
- (should
- (equal "#+BEGIN_VERSE\n A\n B\n#+END_VERSE"
- (org-test-with-temp-text " #+BEGIN_VERSE\n A\n B\n #+END_VERSE"
- (org-indent-region (point-min) (point-max))
- (buffer-string))))
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "#+BEGIN_VERSE\n A\n B\n#+END_VERSE"
+ (org-test-with-temp-text " #+BEGIN_VERSE\n A\n B\n #+END_VERSE"
+ (org-indent-region (point-min) (point-max))
+ (buffer-string)))))
;; Indent example blocks as a single block, unless indentation
;; should be preserved. In this case only indent the block markers.
(should
@@ -1095,36 +1098,38 @@
(org-test-with-temp-text "#+BEGIN_EXAMPLE\n A\n B\n#+END_EXAMPLE"
(org-indent-region (point-min) (point-max))
(buffer-string))))
- (should
- (equal "#+BEGIN_EXAMPLE\n A\n B\n#+END_EXAMPLE"
- (org-test-with-temp-text " #+BEGIN_EXAMPLE\n A\n B\n #+END_EXAMPLE"
- (org-indent-region (point-min) (point-max))
- (buffer-string))))
- (should
- (equal "#+BEGIN_EXAMPLE -i\n A\n B\n#+END_EXAMPLE"
- (org-test-with-temp-text
- " #+BEGIN_EXAMPLE -i\n A\n B\n #+END_EXAMPLE"
- (org-indent-region (point-min) (point-max))
- (buffer-string))))
- (should
- (equal "#+BEGIN_EXAMPLE\n A\n B\n#+END_EXAMPLE"
- (org-test-with-temp-text
- " #+BEGIN_EXAMPLE\n A\n B\n #+END_EXAMPLE"
- (let ((org-src-preserve-indentation t))
- (org-indent-region (point-min) (point-max)))
- (buffer-string))))
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "#+BEGIN_EXAMPLE\n A\n B\n#+END_EXAMPLE"
+ (org-test-with-temp-text " #+BEGIN_EXAMPLE\n A\n B\n #+END_EXAMPLE"
+ (org-indent-region (point-min) (point-max))
+ (buffer-string))))
+ (should
+ (equal "#+BEGIN_EXAMPLE -i\n A\n B\n#+END_EXAMPLE"
+ (org-test-with-temp-text
+ " #+BEGIN_EXAMPLE -i\n A\n B\n #+END_EXAMPLE"
+ (org-indent-region (point-min) (point-max))
+ (buffer-string))))
+ (should
+ (equal "#+BEGIN_EXAMPLE\n A\n B\n#+END_EXAMPLE"
+ (org-test-with-temp-text
+ " #+BEGIN_EXAMPLE\n A\n B\n #+END_EXAMPLE"
+ (let ((org-src-preserve-indentation t))
+ (org-indent-region (point-min) (point-max)))
+ (buffer-string)))))
;; Treat export blocks as a whole.
(should
(equal "#+BEGIN_EXPORT latex\n A\n B\n#+END_EXPORT"
(org-test-with-temp-text "#+BEGIN_EXPORT latex\n A\n B\n#+END_EXPORT"
(org-indent-region (point-min) (point-max))
(buffer-string))))
- (should
- (equal "#+BEGIN_EXPORT latex\n A\n B\n#+END_EXPORT"
- (org-test-with-temp-text
- " #+BEGIN_EXPORT latex\n A\n B\n #+END_EXPORT"
- (org-indent-region (point-min) (point-max))
- (buffer-string))))
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "#+BEGIN_EXPORT latex\n A\n B\n#+END_EXPORT"
+ (org-test-with-temp-text
+ " #+BEGIN_EXPORT latex\n A\n B\n #+END_EXPORT"
+ (org-indent-region (point-min) (point-max))
+ (buffer-string)))))
;; Indent according to mode if `org-src-tab-acts-natively' is
;; non-nil. Otherwise, do not indent code at all.
(should
@@ -1160,16 +1165,17 @@
(org-indent-region (point) (point-max)))
(buffer-string))))
;; Indent plain lists.
- (should
- (equal "- A\n B\n - C\n\n D"
- (org-test-with-temp-text "- A\n B\n - C\n\n D"
- (org-indent-region (point-min) (point-max))
- (buffer-string))))
- (should
- (equal "- A\n\n- B"
- (org-test-with-temp-text " - A\n\n - B"
- (org-indent-region (point-min) (point-max))
- (buffer-string))))
+ (let ((org-adapt-indentation t))
+ (should
+ (equal "- A\n B\n - C\n\n D"
+ (org-test-with-temp-text "- A\n B\n - C\n\n D"
+ (org-indent-region (point-min) (point-max))
+ (buffer-string))))
+ (should
+ (equal "- A\n\n- B"
+ (org-test-with-temp-text " - A\n\n - B"
+ (org-indent-region (point-min) (point-max))
+ (buffer-string)))))
;; Indent footnote definitions.
(should
(equal "[fn:1] Definition\n\nDefinition"
--
2.31.1
next prev parent reply other threads:[~2021-05-09 16:43 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-02 6:09 [POLL] Setting `org-adapt-indentation' to nil by default? Bastien
2021-05-02 7:13 ` Tim Cross
2021-05-02 8:06 ` Jean Louis
2021-05-02 8:47 ` Tim Cross
2021-05-02 20:18 ` Jean Louis
2021-05-02 22:25 ` Tim Cross
2021-05-03 7:41 ` Kévin Le Gouguec
2021-05-03 10:15 ` Jean Louis
2021-05-02 8:56 ` Bastien
2021-05-02 8:59 ` Bastien
2021-05-02 20:24 ` Jean Louis
2021-05-02 20:21 ` Jean Louis
2021-05-02 20:22 ` Jean Louis
2021-05-02 10:07 ` Eric S Fraga
2021-05-02 15:01 ` Detlef Steuer
2021-05-02 15:44 ` Colin Baxter
2021-05-02 15:46 ` Amin Bandali
2021-05-02 18:11 ` Tom Gillespie
2021-05-02 18:19 ` Nicolas Goaziou
2021-05-02 18:48 ` Tom Gillespie
2021-05-02 19:20 ` Nicolas Goaziou
2021-05-03 10:11 ` Dr. Arne Babenhauserheide
2021-05-02 18:31 ` Jim Porter
2021-05-02 20:44 ` Kévin Le Gouguec
2021-05-03 7:33 ` Kévin Le Gouguec
2021-05-03 8:06 ` Bastien
2021-05-03 12:53 ` Kévin Le Gouguec
2021-05-03 13:40 ` Bastien
2021-05-03 14:57 ` Kévin Le Gouguec
2021-05-06 14:50 ` Maxim Nikulin
2021-05-15 20:51 ` Bastien
2021-05-19 17:02 ` [PATCH] etc/ORG-NEWS: Suggest against disabling `electric-indent-mode' Maxim Nikulin
2021-05-20 12:25 ` Bastien
2021-05-19 17:08 ` [PATCH] org-faq.org: Expand "What is the best setup for indenting?" Maxim Nikulin
2021-05-19 18:06 ` Greg Minshall
2021-05-20 15:57 ` Maxim Nikulin
2021-05-21 2:45 ` Greg Minshall
2021-05-27 16:11 ` Maxim Nikulin
2021-05-21 9:38 ` Bastien
2021-05-20 12:28 ` Bastien
2021-05-19 17:08 ` [POLL] Setting `org-adapt-indentation' to nil by default? Maxim Nikulin
2021-05-02 21:07 ` Jack Kamm
2021-05-05 7:54 ` Bastien
2021-05-06 14:13 ` Bastien
2021-05-09 16:42 ` Kévin Le Gouguec [this message]
2021-05-15 12:46 ` Bastien
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=871raf270x.fsf@gmail.com \
--to=kevin.legouguec@gmail.com \
--cc=bzg@gnu.org \
--cc=emacs-orgmode@gnu.org \
/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).