[PATCH] Improve "Speeding Up Your Agendas" chapters

[PATCH] Improve "Speeding Up Your Agendas" chapters

[Stefan Kangas]

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

Please see the attached patches.  Thanks.

[-- Attachment #2: 0001-Move-appendix-on-performance-in-manual-to-agenda-cha.patch --]
[-- Type: text/x-patch, Size: 3690 bytes --]

From 061255f1d6441f1496a3b062d6f29193ff2fb3c2 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Sun, 26 Jun 2022 12:48:06 +0200
Subject: [PATCH 1/2] Move appendix on performance in manual to agenda chapter

* doc/org-manual.org (Speeding Up Your Agendas): Move section to
chapter "Agenda Views".
---
 doc/org-manual.org | 86 +++++++++++++++++++++++-----------------------
 1 file changed, 43 insertions(+), 43 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 4c2e968e7..6bedeb344 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -10738,6 +10738,49 @@ environment.  This causes the following issues:
    today, with the time already spent---via =CLOCKSUM=---and with
    the planned total effort for it.
 
+** Speeding Up Your Agendas
+:PROPERTIES:
+:DESCRIPTION: Tips on how to speed up your agendas.
+:END:
+#+cindex: agenda views, optimization
+
+Some agenda commands slow down when the Org files grow in size or
+number.  Here are tips to speed up:
+
+- Reduce the number of Org agenda files to avoid slowdowns due to hard drive
+  accesses.
+
+- Reduce the number of DONE and archived headlines so agenda
+  operations that skip over these can finish faster.
+
+- Do not dim blocked tasks:
+  #+vindex: org-agenda-dim-blocked-tasks
+
+  #+begin_src emacs-lisp
+  (setq org-agenda-dim-blocked-tasks nil)
+  #+end_src
+
+- Stop preparing agenda buffers on startup:
+  #+vindex: org-startup-folded
+  #+vindex: org-agenda-inhibit-startup
+
+  #+begin_src emacs-lisp
+  (setq org-agenda-inhibit-startup t)
+  #+end_src
+
+- Disable tag inheritance for agendas:
+  #+vindex: org-agenda-show-inherited-tags
+  #+vindex: org-agenda-use-tag-inheritance
+
+  #+begin_src emacs-lisp
+  (setq org-agenda-use-tag-inheritance nil)
+  #+end_src
+
+These options can be applied to selected agenda views.  For more
+details about generation of agenda views, see the docstrings for the
+relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
+optimization.
+
 * Markup for Rich Contents
 :PROPERTIES:
 :DESCRIPTION: Compose beautiful documents.
@@ -21003,49 +21046,6 @@ special function:
     (org-agenda-overriding-header "Projects waiting for something: "))))
 #+end_src
 
-** Speeding Up Your Agendas
-:PROPERTIES:
-:DESCRIPTION: Tips on how to speed up your agendas.
-:END:
-#+cindex: agenda views, optimization
-
-Some agenda commands slow down when the Org files grow in size or
-number.  Here are tips to speed up:
-
-- Reduce the number of Org agenda files to avoid slowdowns due to hard drive
-  accesses.
-
-- Reduce the number of DONE and archived headlines so agenda
-  operations that skip over these can finish faster.
-
-- Do not dim blocked tasks:
-  #+vindex: org-agenda-dim-blocked-tasks
-
-  #+begin_src emacs-lisp
-  (setq org-agenda-dim-blocked-tasks nil)
-  #+end_src
-
-- Stop preparing agenda buffers on startup:
-  #+vindex: org-startup-folded
-  #+vindex: org-agenda-inhibit-startup
-
-  #+begin_src emacs-lisp
-  (setq org-agenda-inhibit-startup t)
-  #+end_src
-
-- Disable tag inheritance for agendas:
-  #+vindex: org-agenda-show-inherited-tags
-  #+vindex: org-agenda-use-tag-inheritance
-
-  #+begin_src emacs-lisp
-  (setq org-agenda-use-tag-inheritance nil)
-  #+end_src
-
-These options can be applied to selected agenda views.  For more
-details about generation of agenda views, see the docstrings for the
-relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
-optimization.
-
 ** Extracting Agenda Information
 :PROPERTIES:
 :DESCRIPTION: Post-processing agenda information.
-- 
2.30.2


[-- Attachment #3: 0002-Document-org-agenda-ignore-drawer-properties-in-manu.patch --]
[-- Type: text/x-patch, Size: 1316 bytes --]

From f6a192e912c32406829f734cb7fe95b47eea5af6 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Sun, 26 Jun 2022 13:07:46 +0200
Subject: [PATCH 2/2] Document org-agenda-ignore-drawer-properties in manual

* doc/org-manual.org (Speeding Up Your Agendas): Document
org-agenda-ignore-drawer-properties.
---
 doc/org-manual.org | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 6bedeb344..914f8db5d 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -10776,6 +10776,17 @@ number.  Here are tips to speed up:
   (setq org-agenda-use-tag-inheritance nil)
   #+end_src
 
+  #+vindex: org-agenda-ignore-drawer-properties
+- Disable parsing of some drawer properties:
+
+  #+begin_src emacs-lisp
+  (setq org-agenda-ignore-drawer-properties '(effort appt stats category))
+  #+end_src
+
+  The drawer properties you can disable in the agenda are effort
+  estimates (~effort~), appointments (~appt~), statistics (~stats~)
+  and subtree-local categories (~category~).
+
 These options can be applied to selected agenda views.  For more
 details about generation of agenda views, see the docstrings for the
 relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
-- 
2.30.2

Re: [PATCH] Improve "Speeding Up Your Agendas" chapters

[Ihor Radchenko]

Stefan Kangas <stefan@marxist.se> writes:

> Subject: [PATCH 1/2] Move appendix on performance in manual to agenda chapter
>
> * doc/org-manual.org (Speeding Up Your Agendas): Move section to
> chapter "Agenda Views".

Does it have to be inside the main chapters of the manual?
I really hope that users do not _normally_ have to know about these
tricks.

> Subject: [PATCH 2/2] Document org-agenda-ignore-drawer-properties in manual
>
> * doc/org-manual.org (Speeding Up Your Agendas): Document
> org-agenda-ignore-drawer-properties.

Note that org-agenda-ignore-drawer-properties is obsolete.

>  These options can be applied to selected agenda views.  For more
>  details about generation of agenda views, see the docstrings for the
>  relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
      ^ (missing trailing ".")

Best,
Ihor

Re: [PATCH] Improve "Speeding Up Your Agendas" chapters

[Stefan Kangas]

Ihor Radchenko <yantar92@gmail.com> writes:

> Does it have to be inside the main chapters of the manual?
> I really hope that users do not _normally_ have to know about these
> tricks.

I've never needed it, FWIW.

However, it also feels misplaced among the appendixes.  I guess this
is subjective: I prefer chapters that deal exhaustively with their
topic.

> > Subject: [PATCH 2/2] Document org-agenda-ignore-drawer-properties in manual
> >
> > * doc/org-manual.org (Speeding Up Your Agendas): Document
> > org-agenda-ignore-drawer-properties.
>
> Note that org-agenda-ignore-drawer-properties is obsolete.
>
> >  These options can be applied to selected agenda views.  For more
> >  details about generation of agenda views, see the docstrings for the
> >  relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
>       ^ (missing trailing ".")

Thanks, I'll update the patch.

Re: [PATCH] Improve "Speeding Up Your Agendas" chapters

[Stefan Kangas]

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

Stefan Kangas <stefan@marxist.se> writes:

> > >  These options can be applied to selected agenda views.  For more
> > >  details about generation of agenda views, see the docstrings for the
> > >  relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
> >       ^ (missing trailing ".")

Note that the "." is on the next line (you can't see it in the patch though).

> Thanks, I'll update the patch.

Please see the attached.

[-- Attachment #2: 0001-Document-org-agenda-ignore-properties-in-manual.patch --]
[-- Type: text/x-patch, Size: 1298 bytes --]

From 34912156ef5e10ad435be7aa7fbb5025124f481a Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefan@marxist.se>
Date: Sun, 26 Jun 2022 13:07:46 +0200
Subject: [PATCH] Document org-agenda-ignore-properties in manual

* doc/org-manual.org (Speeding Up Your Agendas): Document
org-agenda-ignore-properties.
---
 doc/org-manual.org | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 4c2e968e7..1926329ac 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -21041,6 +21041,17 @@ number.  Here are tips to speed up:
   (setq org-agenda-use-tag-inheritance nil)
   #+end_src
 
+  #+vindex: org-agenda-ignore-drawer-properties
+- Disable parsing of some drawer properties:
+
+  #+begin_src emacs-lisp
+  (setq org-agenda-ignore-drawer-properties '(effort appt stats category))
+  #+end_src
+
+  The drawer properties you can disable in the agenda are effort
+  estimates (~effort~), appointments (~appt~), statistics (~stats~)
+  and subtree-local categories (~category~).
+
 These options can be applied to selected agenda views.  For more
 details about generation of agenda views, see the docstrings for the
 relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
-- 
2.30.2

Re: [PATCH] Improve "Speeding Up Your Agendas" chapters

[Ihor Radchenko]

Stefan Kangas <stefan@marxist.se> writes:

> Note that the "." is on the next line (you can't see it in the patch though).
>
>> Thanks, I'll update the patch.
>
> Please see the attached.

Thanks!
Applied onto main via a722f6f8e with amendment to the commit message.
I have added quoting to the variable name:
`org-agenda-ignore-properties'.

Best,
Ihor

Re: [PATCH] Improve "Speeding Up Your Agendas" chapters

[Stefan Kangas]

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

Ihor Radchenko <yantar92@gmail.com> writes:

> Applied onto main via a722f6f8e with amendment to the commit message.

It seems like i bungled the patch: two typos are fixed in the attached.  Thanks.

[-- Attachment #2: 0001-doc-org-manual.org-Speeding-Up-Your-Agendas-Fix-typo.patch --]
[-- Type: application/x-patch, Size: 972 bytes --]

Re: [PATCH] Improve "Speeding Up Your Agendas" chapters

[Ihor Radchenko]

Stefan Kangas <stefan@marxist.se> writes:

> Ihor Radchenko <yantar92@gmail.com> writes:
>
>> Applied onto main via a722f6f8e with amendment to the commit message.
>
> It seems like i bungled the patch: two typos are fixed in the attached.  Thanks.

I swear I did check for this... Still missed.
Applied onto main via 381a2ae4d after removing the trailing "." from the
commit message.

Best,
Ihor