Org-mode `org-move-subtree-down` function strange behavior

Question

The function org-move-subtree-down exhibits an unwanted behavior IMO: when moving the subtree it considers the whitespace above the subtree that will be moved as "part" of it. I think it's better explained visually:

When we try to move down this subtree, see what happens:

If we try to move the 3rd subtree up starting from the same initial configuration (figure 1), something strange will happen as well:

Looking at the code of the function, one can see that this behavior has been intentionally programmed. I wonder why, and if I'm the only one who dislikes this behavior.

I am currently working on hacking this function to correct this behavior, and will propose changes to developers, but wanted to see if it's not the case that I'm crazy here. Thanks, any thoughts will be helpful.

Here is the file I used for you to try the same commands.

Answer 1

Thanks for your observation. I also think this behavior is strange.

The behavior possibly helps some users to maintain certain whitespace patterns for their org files.

With commit

https://code.orgmode.org/bzg/org-mode/commit/a0a40a465108d952ee6452d299ecbc5ffc4ed18a

the movement has been changed to fit your original expectation, I guess.

Answer 2

I tried the file you provided and can reproduce your described behavior. I run the command C-h c which prompts for a key sequence. When I enter M-S-up, which according to the manual should run the command org-move-subtree-up, the actually executed command is org-shiftmetaup.

If you hit M-x org-move-subtree-up RET you should get your desired behavior.

So it seems like a bug to me.

EDIT: I filed the bug - it is a documentation bug. The functionality you are looking for is simply available as M-up or M-down

Answer 3

Use org-cut-subtree and org-paste-subtree as Workaround

1. Place cursor on heading then use C-a to jump to beginning of line.

   For example, place cursor at beginning of line Subheading2 line.

   * Heading 1
   ** Subheading1
   ** Subheading2
      Some text with empty line
   
   ** Subheading3
   

2. Use C-c C-x C-w to cut sub-tree.

   * Heading 1
   ** Subheading1
   ** Subheading3
   

3. Place cursor on destination heading then use C-a to jump to beginning of line.

   For example, place cursor at beginning of line Subheading1 line.

   * Heading 1
   ** Subheading1
   ** Subheading3
   

4. Use C-c C-x C-y to paste sub-tree.

   * Heading 1
   ** Subheading2
      Some text with empty line
   
   ** Subheading1
   ** Subheading3
   

Hope that helped!

---

This answer was validated using:
emacs version: GNU Emacs 25.2.1 (x86_64-unknown-cygwin, GTK+ Version 3.22.10)
org-mode version: 9.1.2