[Accepted] [O] Bulk function documentation is missing

[Bastien Guerry]

Patch 741 (http://patchwork.newartisans.com/patch/741/) is now "Accepted".

Maintainer comment: none

This relates to the following submission:

http://mid.gmane.org/%3CBANLkTimyjyj%2BF8a%3DknRvFhK6HYRvR1ndVg%40mail.gmail.com%3E

Here is the original message containing the patch:

> Content-Type: text/plain; charset="utf-8"
> MIME-Version: 1.0
> Content-Transfer-Encoding: 7bit
> Subject: [O] Bulk function documentation is missing
> Date: Fri, 08 Apr 2011 22:04:09 -
> From: Puneeth Chaganti 
> X-Patchwork-Id: 741
> Message-Id: 
> To: Bernt Hansen , emacs-orgmode ,
>   Bastien 
> Cc: 
> 
> Hi,
> 
> I'd sent it to Bernt alone, on the previous occasion. Re-sending to
> everyone. Sorry for the re-post, Bernt.
> 
> Hi Bernt,
> 
> On Fri, Apr 8, 2011 at 8:52 AM, Bernt Hansen 
> [..]
> > Could you please also provide documentation in org.texi with an example
> > of how you use this?
> 
> I have attached a patch that documents this function. Please feel free
> to improve it.
> 
> Thanks,
> Puneeth
> >From 007f723e5bfd11b1d3c0efbb89b32f1955264314 Mon Sep 17 00:00:00 2001
> From: Puneeth Chaganti 
> Date: Fri, 8 Apr 2011 11:23:31 +0530
> Subject: [PATCH] Document option to allow applying a function as Bulk Agenda
>  action
> 
> * doc/org.texi (Agenda commands): Doc for function option to bulk action.
> 
> ---
> doc/org.texi |   15 +++
>  1 files changed, 15 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/org.texi b/doc/org.texi
> index 5ab25b0..d5c7b7b 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -8075,6 +8075,21 @@ s  @r{Schedule all items to a new date.  To shift 
> existing schedule dates}
>  S  @r{Reschedule randomly by N days.  N will be prompted for.  With prefix}
> @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
>  d  @r{Set deadline to a specific date.}
> +f  @r{Apply a function to marked entries.}
> +   @r{For example, the function below sets the CATEGORY property of the}
> +   @r{entries to web.}
> +   @r{(defun set-category ()}
> +   @r{  (interactive "P")}
> +   @r{  (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
> +   @r{ (org-agenda-error)))}
> +   @r{(buffer (marker-buffer marker)))}
> +   @r{   (with-current-buffer buffer}
> +   @r{ (save-excursion}
> +   @r{   (save-restriction}
> +   @r{ (widen)}
> +   @r{ (goto-char marker)}
> +   @r{ (org-back-to-heading t)}
> +   @r{ (org-set-property "CATEGORY" "web"))}
>  @end example
>  
>  
> 

[O] Bulk function documentation is missing

[Puneeth Chaganti]

Hi,

I'd sent it to Bernt alone, on the previous occasion. Re-sending to
everyone. Sorry for the re-post, Bernt.

Hi Bernt,

On Fri, Apr 8, 2011 at 8:52 AM, Bernt Hansen 
[..]
> Could you please also provide documentation in org.texi with an example
> of how you use this?

I have attached a patch that documents this function. Please feel free
to improve it.

Thanks,
Puneeth
From 007f723e5bfd11b1d3c0efbb89b32f1955264314 Mon Sep 17 00:00:00 2001
From: Puneeth Chaganti 
Date: Fri, 8 Apr 2011 11:23:31 +0530
Subject: [PATCH] Document option to allow applying a function as Bulk Agenda
 action

* doc/org.texi (Agenda commands): Doc for function option to bulk action.
---
 doc/org.texi |   15 +++
 1 files changed, 15 insertions(+), 0 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 5ab25b0..d5c7b7b 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -8075,6 +8075,21 @@ s  @r{Schedule all items to a new date.  To shift 
existing schedule dates}
 S  @r{Reschedule randomly by N days.  N will be prompted for.  With prefix}
@r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
 d  @r{Set deadline to a specific date.}
+f  @r{Apply a function to marked entries.}
+   @r{For example, the function below sets the CATEGORY property of the}
+   @r{entries to web.}
+   @r{(defun set-category ()}
+   @r{  (interactive "P")}
+   @r{  (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
+   @r{ (org-agenda-error)))}
+   @r{(buffer (marker-buffer marker)))}
+   @r{   (with-current-buffer buffer}
+   @r{ (save-excursion}
+   @r{   (save-restriction}
+   @r{ (widen)}
+   @r{ (goto-char marker)}
+   @r{ (org-back-to-heading t)}
+   @r{ (org-set-property "CATEGORY" "web"))}
 @end example
 
 
-- 
1.7.4.4

[O] Bulk function documentation is missing

[Bernt Hansen]

Hi Puneeth,

I just ran across the new Bulk action feature which applies a function
to the marked entries in the agenda.  There is no documentation for this
feature that I can find other than in the commit itself.

This functionality was added by you in 5b1b94a (* org-agenda.el
(org-agenda-bulk-action): Allow the user to run a function., 2011-03-08)

Could you please also provide documentation in org.texi with an example
of how you use this?

Thanks,
Bernt