* [PATCH] man: update SEE ALSO references in man pages
@ 2012-03-11 21:36 Jani Nikula
2012-03-13 17:35 ` Austin Clements
2012-03-14 1:15 ` David Bremner
0 siblings, 2 replies; 4+ messages in thread
From: Jani Nikula @ 2012-03-11 21:36 UTC (permalink / raw)
To: notmuch
Drop references to notmuch-part(1). Reference all man pages. Fix man
page section of notmuch-dump(1).
---
man/man1/notmuch-config.1 | 5 ++---
man/man1/notmuch-count.1 | 8 ++++----
man/man1/notmuch-dump.1 | 8 ++++----
man/man1/notmuch-new.1 | 8 ++++----
man/man1/notmuch-reply.1 | 8 ++++----
man/man1/notmuch-restore.1 | 8 ++++----
man/man1/notmuch-search.1 | 8 ++++----
man/man1/notmuch-show.1 | 8 ++++----
man/man1/notmuch-tag.1 | 8 ++++----
man/man1/notmuch.1 | 7 +++----
man/man5/notmuch-hooks.5 | 8 ++++----
man/man7/notmuch-search-terms.7 | 5 ++---
12 files changed, 43 insertions(+), 46 deletions(-)
diff --git a/man/man1/notmuch-config.1 b/man/man1/notmuch-config.1
index e62577c..d22988a 100644
--- a/man/man1/notmuch-config.1
+++ b/man/man1/notmuch-config.1
@@ -137,9 +137,8 @@ Specifies the location of the notmuch configuration file. Notmuch will
use ${HOME}/.notmuch\-config if this variable is not set.
.SH SEE ALSO
-\fBnotmuch\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
-\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1),
+\fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
+\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-reply\fR(1),
\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-count.1 b/man/man1/notmuch-count.1
index 805a8ae..f593065 100644
--- a/man/man1/notmuch-count.1
+++ b/man/man1/notmuch-count.1
@@ -51,7 +51,7 @@ Do not exclude the messages matching search.exclude_tags in the config file.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-dump\fR(1),
-\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1),
-\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
-\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-reply\fR(1),
+\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1
index bd7e274..4e24392 100644
--- a/man/man1/notmuch-dump.1
+++ b/man/man1/notmuch-dump.1
@@ -31,7 +31,7 @@ for details of the supported syntax for <search-terms>.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1),
-\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
-\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-reply\fR(1),
+\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-new.1 b/man/man1/notmuch-new.1
index ccee738..19cef3d 100644
--- a/man/man1/notmuch-new.1
+++ b/man/man1/notmuch-new.1
@@ -64,7 +64,7 @@ Prevents hooks from being run.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-part\fR(1),
-\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
-\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),
+\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1
index 7ed7f0f..0fb68b4 100644
--- a/man/man1/notmuch-reply.1
+++ b/man/man1/notmuch-reply.1
@@ -80,7 +80,7 @@ on issue found in multiple patches.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
-\fBnotmuch-part\fR(1), \fBnotmuch-restore\fR(1),
-\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
+\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1
index 8bd59e4..bcb765c 100644
--- a/man/man1/notmuch-restore.1
+++ b/man/man1/notmuch-restore.1
@@ -39,7 +39,7 @@ details.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1),
-\fBnotmuch-reply\fR(1), \fBnotmuch-dump\fR(1),
-\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
+\fBnotmuch-reply\fR(1), \fBnotmuch-search\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1
index 8426aa3..c62ad18 100644
--- a/man/man1/notmuch-search.1
+++ b/man/man1/notmuch-search.1
@@ -122,7 +122,7 @@ Do not exclude the messages matching search.exclude_tags in the config file.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-part\fR(1),
-\fBnotmuch-reply\fR(1), \fBnotmuch-reply\fR(1),
-\fBnotmuch-restore\fR(1), \fBnotmuch-search-terms\fR(7),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
+\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1
index d75d971..ebdd189 100644
--- a/man/man1/notmuch-show.1
+++ b/man/man1/notmuch-show.1
@@ -146,7 +146,7 @@ command.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
-\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1),
-\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
-\fBnotmuch-search-terms\fR(7), \fBnotmuch-tag\fR(1)
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
+\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
+\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1
index 8e0bb5c..9f62222 100644
--- a/man/man1/notmuch-tag.1
+++ b/man/man1/notmuch-tag.1
@@ -32,7 +32,7 @@ details.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
-\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1),
-\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
-\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1)
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
+\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
+\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
+\fBnotmuch-show\fR(1),
diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1
index 3ab1af5..6fd20e0 100644
--- a/man/man1/notmuch.1
+++ b/man/man1/notmuch.1
@@ -131,10 +131,9 @@ use ${HOME}/.notmuch\-config if this variable is not set.
\fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
-\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1),
-\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
-\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
-\fBnotmuch-tag\fR(1)
+\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
+\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
+\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
The notmuch website:
diff --git a/man/man5/notmuch-hooks.5 b/man/man5/notmuch-hooks.5
index 1e459c0..ab40443 100644
--- a/man/man5/notmuch-hooks.5
+++ b/man/man5/notmuch-hooks.5
@@ -42,7 +42,7 @@ imported messages.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1),
-\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
-\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-dump\fR(1), \fBnotmuch-new\fR(1), \fBnotmuch-reply\fR(1),
+\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
+\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
+\fBnotmuch-tag\fR(1)
diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7
index 09a699f..1d43042 100644
--- a/man/man7/notmuch-search-terms.7
+++ b/man/man7/notmuch-search-terms.7
@@ -135,7 +135,6 @@ current time:
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
-\fBnotmuch-dump\fR(5), \fBnotmuch-hooks\fR(5), \fBnotmuch-part\fR(1),
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
-\fBnotmuch-search\fR(1), \fBnotmuch-search\fR(1),
-\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
+\fBnotmuch-search\fR(1), \fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
--
1.7.5.4
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] man: update SEE ALSO references in man pages
2012-03-11 21:36 [PATCH] man: update SEE ALSO references in man pages Jani Nikula
@ 2012-03-13 17:35 ` Austin Clements
2012-03-13 18:35 ` Jani Nikula
2012-03-14 1:15 ` David Bremner
1 sibling, 1 reply; 4+ messages in thread
From: Austin Clements @ 2012-03-13 17:35 UTC (permalink / raw)
To: Jani Nikula; +Cc: notmuch
Quoth Jani Nikula on Mar 11 at 11:36 pm:
> Drop references to notmuch-part(1). Reference all man pages. Fix man
> page section of notmuch-dump(1).
This LGTM, but is it actually what we want? Referencing everything
from everything seems to defeat the purpose. I would expect
notmuch(1) to reference everything, but the command manpages to only
reference notmuch(1) and specific, related commands (e.g., dump and
restore should reference each other; new should reference hooks;
count, dump, reply, search, show, and tag should reference
search-terms; and new, search, and reply should reference config).
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] man: update SEE ALSO references in man pages
2012-03-13 17:35 ` Austin Clements
@ 2012-03-13 18:35 ` Jani Nikula
0 siblings, 0 replies; 4+ messages in thread
From: Jani Nikula @ 2012-03-13 18:35 UTC (permalink / raw)
To: Austin Clements; +Cc: notmuch
On Tue, 13 Mar 2012 13:35:44 -0400, Austin Clements <amdragon@MIT.EDU> wrote:
> Quoth Jani Nikula on Mar 11 at 11:36 pm:
> > Drop references to notmuch-part(1). Reference all man pages. Fix man
> > page section of notmuch-dump(1).
>
> This LGTM, but is it actually what we want? Referencing everything
> from everything seems to defeat the purpose. I would expect
> notmuch(1) to reference everything, but the command manpages to only
> reference notmuch(1) and specific, related commands (e.g., dump and
> restore should reference each other; new should reference hooks;
> count, dump, reply, search, show, and tag should reference
> search-terms; and new, search, and reply should reference config).
Hi Austin, while I agree with you, I think I'll have to leave that bit
for another patch, another time (and possibly another author ;). My
purpose here was to just quickly fix the current references, for which
the logic was that all pages reference all other pages.
BR,
Jani.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] man: update SEE ALSO references in man pages
2012-03-11 21:36 [PATCH] man: update SEE ALSO references in man pages Jani Nikula
2012-03-13 17:35 ` Austin Clements
@ 2012-03-14 1:15 ` David Bremner
1 sibling, 0 replies; 4+ messages in thread
From: David Bremner @ 2012-03-14 1:15 UTC (permalink / raw)
To: Jani Nikula, notmuch
On Sun, 11 Mar 2012 23:36:16 +0200, Jani Nikula <jani@nikula.org> wrote:
> Drop references to notmuch-part(1). Reference all man pages. Fix man
> page section of notmuch-dump(1).
pushed. As jani says, we can certainly improve the cross references
later.
d
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2012-03-14 1:15 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-03-11 21:36 [PATCH] man: update SEE ALSO references in man pages Jani Nikula
2012-03-13 17:35 ` Austin Clements
2012-03-13 18:35 ` Jani Nikula
2012-03-14 1:15 ` 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).