Bug: Typo in archive location example in manual [9.3.7 (release_9.3.7-807-gf1363d @ /home/yantar92/.emacs.d/straight/build/org/)]

Bug: Typo in archive location example in manual [9.3.7 (release_9.3.7-807-gf1363d @ /home/yantar92/.emacs.d/straight/build/org/)]

[Ihor Radchenko]

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


Remember to cover the basics, that is, what you expected to happen and
what in fact did happen.  You don't know how to make a good report?  See

     https://orgmode.org/manual/Feedback.html#Feedback

Your bug report will be posted to the Org mailing list.
------------------------------------------------------------------------

Archive location example in 16.7 Summary of In-Buffer Settings section
of the manual is not valid. Patch attached.

Best,
Ihor


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-example-of-in-buffer-setting-of-archive-location.patch --]
[-- Type: text/x-diff, Size: 809 bytes --]

From f1363d0b27494afcff4ab6a96d31d3e05c235f71 Mon Sep 17 00:00:00 2001
From: Ihor Radchenko <yantar92@gmail.com>
Date: Sun, 13 Sep 2020 11:51:01 +0800
Subject: [PATCH] Fix example of in-buffer setting of archive location in
 manual

The provided example '%s_done' is not valid syntax for archive
location. Should be '%s_done::'.
---
 doc/org-manual.org | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 46498bd22..117e691e8 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -18854,7 +18854,7 @@ Closing and reopening the Org file in Emacs also activates the
 changes.
 
 #+attr_texinfo: :sep ,
-- =#+ARCHIVE: %s_done= ::
+- =#+ARCHIVE: %s_done::= ::
 
   #+cindex: @samp{ARCHIVE}, keyword
   #+vindex: org-archive-location
-- 
2.26.2


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



Emacs  : GNU Emacs 28.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.20, cairo version 1.16.0)
 of 2020-08-15
Package: Org mode version 9.3.7 (release_9.3.7-807-gf1363d @ /home/yantar92/.emacs.d/straight/build/org/)

Re: Bug: Typo in archive location example in manual [9.3.7 (release_9.3.7-807-gf1363d @ /home/yantar92/.emacs.d/straight/build/org/)]

[Kyle Meyer]

Ihor Radchenko writes:

> Archive location example in 16.7 Summary of In-Buffer Settings section
> of the manual is not valid. Patch attached.

> Subject: [PATCH] Fix example of in-buffer setting of archive location in
>  manual
>
> The provided example '%s_done' is not valid syntax for archive
> location. Should be '%s_done::'.

Thanks for spotting that.  Applied in 8efec3d4c, adding a changelog
entry to the message.

Re: Bug: Typo in archive location example in manual [9.3.7 (release_9.3.7-807-gf1363d @ /home/yantar92/.emacs.d/straight/build/org/)]

[Ihor Radchenko]

> Thanks for spotting that.  Applied in 8efec3d4c, adding a changelog
> entry to the message.

Thanks!

By the way, do you know how to automatically format changelog entries in
magit. The suggestion from contribute page seems outdated (or I miss
something):

> If you are using magit.el in Emacs, the ChangeLog for such entries are
> easily produced by pressing C in the diff listing.

Best,
Ihor

Kyle Meyer <kyle@kyleam.com> writes:

> Ihor Radchenko writes:
>
>> Archive location example in 16.7 Summary of In-Buffer Settings section
>> of the manual is not valid. Patch attached.
>
>> Subject: [PATCH] Fix example of in-buffer setting of archive location in
>>  manual
>>
>> The provided example '%s_done' is not valid syntax for archive
>> location. Should be '%s_done::'.
>
> Thanks for spotting that.  Applied in 8efec3d4c, adding a changelog
> entry to the message.

Re: Bug: Typo in archive location example in manual [9.3.7 (release_9.3.7-807-gf1363d @ /home/yantar92/.emacs.d/straight/build/org/)]

[Bastien]

Hi Ihor,

Ihor Radchenko <yantar92@gmail.com> writes:

> By the way, do you know how to automatically format changelog entries in
> magit. 

I use C-x 4 a in the diff listing from magit.

> The suggestion from contribute page seems outdated (or I miss
> something):
>
>> If you are using magit.el in Emacs, the ChangeLog for such entries are
>> easily produced by pressing C in the diff listing.

Fixed in worg as 4cedd6d2, thanks!

-- 
 Bastien

changelog entry via Magit (was Bug: Typo in archive location example in manual)

[Kyle Meyer]

Ihor Radchenko writes:

> By the way, do you know how to automatically format changelog entries in
> magit. The suggestion from contribute page seems outdated (or I miss
> something):
>
>> If you are using magit.el in Emacs, the ChangeLog for such entries are
>> easily produced by pressing C in the diff listing.

Hmm, that's what I use.  If you go to the diff buffer that (by default)
is popped up while committing [*], hitting C (magit-commit-add-log) on a
hunk should add an entry to the commit message buffer.

What happens on your end?  (And what version of Magit are you using?)


  [*] I haven't followed it closely, but Noam Postavsky has worked on
      improving changelog generation in Emacs (shipped with Emacs 27, I
      believe) and then using that in Magit (in-flight PR).  IIUC the
      end result is that the full changelog skeleton could be inserted
      by calling a single command from the commit message buffer.  (And
      calling the command manually could be avoided by adding it to
      git-commit-setup-hook.)

      https://debbugs.gnu.org/cgi/bugreport.cgi?bug=16301#11
      https://github.com/magit/magit/issues/2931
      https://github.com/magit/magit/pull/3928

Re: changelog entry via Magit (was Bug: Typo in archive location example in manual)

[Bastien]

Hi Kyle,

Kyle Meyer <kyle@kyleam.com> writes:

> Hmm, that's what I use.  If you go to the diff buffer that (by default)
> is popped up while committing [*], hitting C (magit-commit-add-log) on a
> hunk should add an entry to the commit message buffer.

Er, you're right, of course -- I was stuck using C-x 4 a from within
magit diff display (which kinda works too), but C on staged files is
so much better!

I've updated Worg to mention both C and C-x 4 a, I hope this helps.

Best,

-- 
 Bastien

Re: changelog entry via Magit (was Bug: Typo in archive location example in manual)

[Ihor Radchenko]

> Hmm, that's what I use.  If you go to the diff buffer that (by default)
> is popped up while committing [*], hitting C (magit-commit-add-log) on a
> hunk should add an entry to the commit message buffer.
>
> What happens on your end?  (And what version of Magit are you using?)

Thanks for the pointer about magit-commit-add-log! It indeed works, but
the binding was shadowed by my modal bindings in boon-mode. I usually
access the magit commands from transient magit help menu.
magit-commit-add-log is not listed there.

Best,
Ihor

Kyle Meyer <kyle@kyleam.com> writes:

> Ihor Radchenko writes:
>
>> By the way, do you know how to automatically format changelog entries in
>> magit. The suggestion from contribute page seems outdated (or I miss
>> something):
>>
>>> If you are using magit.el in Emacs, the ChangeLog for such entries are
>>> easily produced by pressing C in the diff listing.
>
> Hmm, that's what I use.  If you go to the diff buffer that (by default)
> is popped up while committing [*], hitting C (magit-commit-add-log) on a
> hunk should add an entry to the commit message buffer.
>
> What happens on your end?  (And what version of Magit are you using?)
>
>
>   [*] I haven't followed it closely, but Noam Postavsky has worked on
>       improving changelog generation in Emacs (shipped with Emacs 27, I
>       believe) and then using that in Magit (in-flight PR).  IIUC the
>       end result is that the full changelog skeleton could be inserted
>       by calling a single command from the commit message buffer.  (And
>       calling the command manually could be avoided by adding it to
>       git-commit-setup-hook.)
>
>       https://debbugs.gnu.org/cgi/bugreport.cgi?bug=16301#11
>       https://github.com/magit/magit/issues/2931
>       https://github.com/magit/magit/pull/3928