[PATCH 2/2] doc/org-manual.org: Document org-clock-{in,out}-switch-to-state

["Samuel W. Flint" <swflint+orgmode@flintfam.org>]

* doc/org-manual.org (Clocking commands): Document operation of
org-clock-{in,out}-switch-to-state, org-clock-{in,out}-next-state, and
org-clock-{in,out}-next-state-function.
---
 doc/org-manual.org | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index ad584d7a5..600690da2 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -6583,6 +6583,17 @@ about what to do with it.
   C-u C-u)}}} prefixes, force continuous clocking by starting the
   clock when the last clock stopped.
 
+  #+vindex: org-clock-in-switch-to-state
+  #+vindex: org-clock-in-next-state
+  #+findex: org-clock-in-next-state-function
+  The variable ~org-clock-in-switch-to-state~ controls if and how a
+  current task's TODO state is changed.  No change (a ~nil~) is the
+  default.  A specific state may be forced with a string value.  The
+  ~org-clock-in-next-state~ alist may be utilized by setting it to
+  ~org-clock-in-next-state-function~, or a custom function may be
+  used.  This custom function should take the current state, and
+  return either a new state or ~nil~ to keep the current state.
+
   #+cindex: @samp{CLOCK_MODELINE_TOTAL}, property
   #+cindex: @samp{LAST_REPEAT}, property
   #+vindex: org-clock-mode-line-total
@@ -6618,6 +6629,17 @@ about what to do with it.
   timestamp[fn:: The corresponding in-buffer setting is: =#+STARTUP:
   lognoteclock-out=.].
 
+  #+vindex: org-clock-out-switch-to-state
+  #+vindex: org-clock-out-next-state
+  #+findex: org-clock-out-next-state-function
+  The variable ~org-clock-out-switch-to-state~ controls if and how a
+  current task's TODO state is changed.  No change (a ~nil~) is the
+  default.  A specific state may be forced with a string value.  The
+  ~org-clock-out-next-state~ alist may be utilized by setting it to
+  ~org-clock-out-next-state-function~, or a custom function may be
+  used.  This custom function should take the current state, and
+  return either a new state or ~nil~ to keep the current state.
+
 - {{{kbd(C-c C-x C-x)}}} (~org-clock-in-last~) ::
 
   #+kindex: C-c C-x C-x
-- 
2.37.3



-- 
Samuel W. Flint
4096R/FA13D704
      (F50D 862B 4F65 5943 A8C2  EF0E 86C9 3E7A FA13 D704)
λs.(s s) λs.(s s)
O< ascii ribbon campaign - stop html mail - www.asciiribbon.org