[PATCH] man: update SEE ALSO references in man pages
On Sun, 11 Mar 2012 23:36:16 +0200, Jani Nikula 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
[PATCH] man: update SEE ALSO references in man pages
On Tue, 13 Mar 2012 13:35:44 -0400, Austin Clements 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.
[PATCH] man: update SEE ALSO references in man pages
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).
Re: [PATCH] man: update SEE ALSO references in man pages
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). ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] man: update SEE ALSO references in man pages
On Tue, 13 Mar 2012 13:35:44 -0400, Austin Clements amdra...@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. ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
Re: [PATCH] man: update SEE ALSO references in man pages
On Sun, 11 Mar 2012 23:36:16 +0200, Jani Nikula j...@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 ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH] man: update SEE ALSO references in man pages
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 .
.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),
[PATCH] man: update SEE ALSO references in man pages
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),
