Rev 2429: Update the doc_generate logic to include see-also help topics. in file:///home/robertc/source/baz/see-also/

[Robert Collins]

At file:///home/robertc/source/baz/see-also/

------------------------------------------------------------
revno: 2429
revision-id: robertc at robertcollins.net-20070419053224-f5lkin1fbjj2ci0s
parent: robertc at robertcollins.net-20070419052137-vsncwlmi8epl5eel
committer: Robert Collins <robertc at robertcollins.net>
branch nick: see-also
timestamp: Thu 2007-04-19 15:32:24 +1000
message:
  Update the doc_generate logic to include see-also help topics.
  (Robert Collins)
modified:
  NEWS                           NEWS-20050323055033-4e00b5db738777ff
  tools/doc_generate/autodoc_man.py bzrman.py-20050601153041-0ff7f74de456d15e
  tools/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
=== modified file 'NEWS'
--- a/NEWS	2007-04-19 04:54:08 +0000
+++ b/NEWS	2007-04-19 05:32:24 +0000
@@ -9,7 +9,9 @@
       Pool)
 
     * ``bzr help`` now provides cross references to other help topics using
-      the _see_also facility on command classes. (Robert Collins)
+      the _see_also facility on command classes. Likewise the bzr_man
+      documentation, and the bzr.1 man page also include this information.
+      (Robert Collins)
 
   INTERNALS:
 

=== modified file 'tools/doc_generate/autodoc_man.py'
--- a/tools/doc_generate/autodoc_man.py	2007-03-26 09:59:49 +0000
+++ b/tools/doc_generate/autodoc_man.py	2007-04-19 05:32:24 +0000
@@ -131,7 +131,14 @@
         aliases_str += ', '.join(cmd.aliases)
         aliases_str += '\n'
 
-    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
+    see_also_str = ""
+    see_also = cmd.get_see_also()
+    if see_also:
+        see_also_str += '\nSee also: '
+        see_also_str += ', '.join(see_also)
+        see_also_str += '\n'
+
+    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
 
 
 man_preamble = """\

=== modified file 'tools/doc_generate/autodoc_rstx.py'
--- a/tools/doc_generate/autodoc_rstx.py	2007-03-27 00:35:29 +0000
+++ b/tools/doc_generate/autodoc_rstx.py	2007-04-19 05:32:24 +0000
@@ -135,7 +135,14 @@
         aliases_str += ', '.join(cmd.aliases)
         aliases_str += '\n'
 
-    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
+    see_also_str = ""
+    see_also = cmd.get_see_also()
+    if see_also:
+        see_also_str += '\n    See also: '
+        see_also_str += ', '.join(see_also)
+        see_also_str += '\n'
+
+    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
 
 
 ##