unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH] doc: tweak hook configuration documentation.
@ 2021-06-22 23:13 David Bremner
  2021-06-23  9:07 ` Hannu Hartikainen
  0 siblings, 1 reply; 3+ messages in thread
From: David Bremner @ 2021-06-22 23:13 UTC (permalink / raw)
  To: notmuch; +Cc: David Bremner

Add a historical note, and hint to look below for more about hooks.
Capitalized the heading for consistency.
---
 doc/man1/notmuch-config.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 56f4a160..eb941dc8 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -85,6 +85,10 @@ paths are presumed relative to `$HOME` for items in section
     Directory containing hooks run by notmuch commands. See
     :any:`notmuch-hooks(5)`.
 
+    History: this configuration value was introduced in notmuch 0.32.
+
+    Default: See HOOKS, below.
+
 **user.name**
     Your full name.
 
@@ -261,7 +265,7 @@ Notmuch configuration file search order:
    by :envvar:`NOTMUCH_PROFILE` environment variable if set,
    ``$HOME/.notmuch-config`` otherwise.
 
-Hooks
+HOOKS
 -----
 
 Notmuch hook directory search order:
-- 
2.30.2

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] doc: tweak hook configuration documentation.
  2021-06-22 23:13 [PATCH] doc: tweak hook configuration documentation David Bremner
@ 2021-06-23  9:07 ` Hannu Hartikainen
  2021-06-25 12:44   ` David Bremner
  0 siblings, 1 reply; 3+ messages in thread
From: Hannu Hartikainen @ 2021-06-23  9:07 UTC (permalink / raw)
  To: David Bremner, notmuch; +Cc: David Bremner

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


LGTM, but because there is an empty line after `**database.hook_dir**`
that section has different indentation than others in the generated
manpage. Might as well fix that too. See snippet below, from a rendered
manpage on my machine.

Hannu

---
       database.backup_dir
              Directory to store tag dumps when upgrading database.

              History: this configuration value was  introduced  in
              notmuch 0.32.

              Default:  A  sibling directory of the Xapian database
              called backups.

       database.hook_dir
          Directory containing hooks run by notmuch  commands.  See
          notmuch-hooks(5).

          History:  this configuration value was introduced in not???
          much 0.32.

          Default: See HOOKS, below.

[-- Attachment #2: Type: text/plain, Size: 0 bytes --]



^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] doc: tweak hook configuration documentation.
  2021-06-23  9:07 ` Hannu Hartikainen
@ 2021-06-25 12:44   ` David Bremner
  0 siblings, 0 replies; 3+ messages in thread
From: David Bremner @ 2021-06-25 12:44 UTC (permalink / raw)
  To: Hannu Hartikainen, notmuch

Hannu Hartikainen <hannu.hartikainen@gmail.com> writes:

> LGTM, but because there is an empty line after `**database.hook_dir**`
> that section has different indentation than others in the generated
> manpage. Might as well fix that too. See snippet below, from a rendered
> manpage on my machine.

Thanks for the suggestion. Done, applied to release and master.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-07-31  0:09 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-22 23:13 [PATCH] doc: tweak hook configuration documentation David Bremner
2021-06-23  9:07 ` Hannu Hartikainen
2021-06-25 12:44   ` David Bremner

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).