Add "SEE ALSO" sections to most man pages. Fixes Debian bug

#551428.

* docs/man/grub-editenv.h2m (SEE ALSO): New section.
* docs/man/grub-emu.h2m (SEE ALSO): Likewise.
* docs/man/grub-fstest.h2m (SEE ALSO): Likewise.
* docs/man/grub-install.h2m (SEE ALSO): Likewise.
* docs/man/grub-macho2img.h2m (SEE ALSO): Likewise.
* docs/man/grub-menulst2cfg.h2m (SEE ALSO): Likewise.
* docs/man/grub-mkconfig.h2m (SEE ALSO): Likewise.
* docs/man/grub-mkdevicemap.h2m (SEE ALSO): Likewise.
* docs/man/grub-mkfont.h2m (SEE ALSO): Likewise.
* docs/man/grub-mkimage.h2m (SEE ALSO): Likewise.
* docs/man/grub-mklayout.h2m (SEE ALSO): Likewise.
* docs/man/grub-mknetdir.h2m (SEE ALSO): Likewise.
* docs/man/grub-mkpasswd-pbkdf2.h2m (SEE ALSO): Likewise.
* docs/man/grub-mkrelpath.h2m (SEE ALSO): Likewise.
* docs/man/grub-mkrescue.h2m (SEE ALSO): Likewise.
* docs/man/grub-ofpathname.h2m (SEE ALSO): Likewise.
* docs/man/grub-pe2elf.h2m (SEE ALSO): Likewise.
* docs/man/grub-probe.h2m (SEE ALSO): Likewise.
* docs/man/grub-reboot.h2m (SEE ALSO): Likewise.
* docs/man/grub-script-check.h2m (SEE ALSO): Likewise.
* docs/man/grub-set-default.h2m (SEE ALSO): Likewise.
* docs/man/grub-setup.h2m (SEE ALSO): Likewise.

diff --git a/ChangeLog b/ChangeLog
index 1142cf81de6a81a130b67766b13ec04683ed2253..3b98caba330aba542a266f6ca8d33e9c88218b0f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,31 @@
+2011-04-21  Colin Watson  <cjwatson@ubuntu.com>
+
+       Add "SEE ALSO" sections to most man pages.  Fixes Debian bug
+       #551428.
+
+       * docs/man/grub-editenv.h2m (SEE ALSO): New section.
+       * docs/man/grub-emu.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-fstest.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-install.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-macho2img.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-menulst2cfg.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mkconfig.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mkdevicemap.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mkfont.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mkimage.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mklayout.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mknetdir.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mkpasswd-pbkdf2.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mkrelpath.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-mkrescue.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-ofpathname.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-pe2elf.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-probe.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-reboot.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-script-check.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-set-default.h2m (SEE ALSO): Likewise.
+       * docs/man/grub-setup.h2m (SEE ALSO): Likewise.
+
 2011-04-21  Colin Watson  <cjwatson@ubuntu.com>
 
        * grub-core/kern/emu/getroot.c

diff --git a/docs/man/grub-editenv.h2m b/docs/man/grub-editenv.h2m
index efbd790709b0462a3ddded44f50d068e61dde80d..3859d3d4c4f2236af6d32f7da6b1c3efe92eba9e 100644 (file)
--- a/docs/man/grub-editenv.h2m
+++ b/docs/man/grub-editenv.h2m
@@ -1,2 +1,5 @@
 [NAME]
 grub-editenv \- edit GRUB environment block
+[SEE ALSO]
+.BR grub-reboot (8),
+.BR grub-set-default (8)

diff --git a/docs/man/grub-emu.h2m b/docs/man/grub-emu.h2m
index 09a1f88c17319c5591bac56133e2d8e73ba2fc69..ef1c000656ad1f978f18847d2d68d86e67d9db8c 100644 (file)
--- a/docs/man/grub-emu.h2m
+++ b/docs/man/grub-emu.h2m
@@ -1,2 +1,6 @@
 [NAME]
 grub-emu \- GRUB emulator
+[SEE ALSO]
+If you are trying to install GRUB, then you should use
+.BR grub-install (8)
+rather than this program.

diff --git a/docs/man/grub-fstest.h2m b/docs/man/grub-fstest.h2m
index be39429b519422d3570eb1eab29abcc765b5b79b..9676b159afdaeda8d106bb2404f2d413ffb6a8ec 100644 (file)
--- a/docs/man/grub-fstest.h2m
+++ b/docs/man/grub-fstest.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-fstest \- debug tool for GRUB filesystem drivers
+[SEE ALSO]
+.BR grub-probe (8)

diff --git a/docs/man/grub-install.h2m b/docs/man/grub-install.h2m
index 65252155c24d3831f699be215ded329fc645d266..2de371a3fddd2516df9c20b748d8b76ab3c0b286 100644 (file)
--- a/docs/man/grub-install.h2m
+++ b/docs/man/grub-install.h2m
@@ -1,2 +1,7 @@
 [NAME]
 grub-install \- install GRUB to a device
+[SEE ALSO]
+.BR grub-mkconfig (8),
+.BR grub-mkimage (1),
+.BR grub-setup (8),
+.BR grub-mkrescue (1)

diff --git a/docs/man/grub-macho2img.h2m b/docs/man/grub-macho2img.h2m
index 412bf926acb4ada5c72ae083a05dbddeea42a4c6..d79aaeed8f9c12f4bf569d1f8790ef9053f31f16 100644 (file)
--- a/docs/man/grub-macho2img.h2m
+++ b/docs/man/grub-macho2img.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-macho2img \- convert Mach-O to raw image
+[SEE ALSO]
+.BR grub-mkimage (1)

diff --git a/docs/man/grub-menulst2cfg.h2m b/docs/man/grub-menulst2cfg.h2m
index 0c0570f27bab85966ec27e313659a3cb8d0ca340..c2e0055ed7e71f09bc573ab9a656107f69d1c747 100644 (file)
--- a/docs/man/grub-menulst2cfg.h2m
+++ b/docs/man/grub-menulst2cfg.h2m
@@ -1,3 +1,4 @@
 [NAME]
 grub-menulst2cfg \- transform legacy menu.lst into grub.cfg
-
+[SEE ALSO]
+.BR grub-mkconfig (8)

diff --git a/docs/man/grub-mkconfig.h2m b/docs/man/grub-mkconfig.h2m
index b0d33ec613fb034c7c737f6430e57e4880d09154..9b42f81301099a1c9dc69cf73ca2e74d83274282 100644 (file)
--- a/docs/man/grub-mkconfig.h2m
+++ b/docs/man/grub-mkconfig.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mkconfig \- generate a GRUB configuration file
+[SEE ALSO]
+.BR grub-install (8)

diff --git a/docs/man/grub-mkdevicemap.h2m b/docs/man/grub-mkdevicemap.h2m
index 8ab34ac866aa3a6b22c49f483d515fe0e404cf7e..3ef8e971276ccc8b5787c46070e1f4b95226cf62 100644 (file)
--- a/docs/man/grub-mkdevicemap.h2m
+++ b/docs/man/grub-mkdevicemap.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mkdevicemap \- generate a GRUB device map file automatically
+[SEE ALSO]
+.BR grub-install (8)

diff --git a/docs/man/grub-mkfont.h2m b/docs/man/grub-mkfont.h2m
index d8580186f45598b85c9065882dd66bf4cb6417c8..d46fe600eca221521bdbf5552e4101b3cf736adc 100644 (file)
--- a/docs/man/grub-mkfont.h2m
+++ b/docs/man/grub-mkfont.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mkfont \- make GRUB font files
+[SEE ALSO]
+.BR grub-mkconfig (8)

diff --git a/docs/man/grub-mkimage.h2m b/docs/man/grub-mkimage.h2m
index 71f270940c30a3155fe094f1a5e27f640f1d7c42..ca08b0c5c4764cdd305c5d55580c91c3f4612f75 100644 (file)
--- a/docs/man/grub-mkimage.h2m
+++ b/docs/man/grub-mkimage.h2m
@@ -1,2 +1,7 @@
 [NAME]
 grub-mkimage \- make a bootable image of GRUB
+[SEE ALSO]
+.BR grub-install (8),
+.BR grub-setup (8),
+.BR grub-mkrescue (1),
+.BR grub-mknetdir (8)

diff --git a/docs/man/grub-mklayout.h2m b/docs/man/grub-mklayout.h2m
index e0ae9dedb663324728c3d5c3adfd1fd8e73d1a46..cda6f3676502e084c0ae15902f731f94c4005635 100644 (file)
--- a/docs/man/grub-mklayout.h2m
+++ b/docs/man/grub-mklayout.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mklayout \- generate a GRUB keyboard layout file
+[SEE ALSO]
+.BR grub-mkconfig (8)

diff --git a/docs/man/grub-mknetdir.h2m b/docs/man/grub-mknetdir.h2m
index 26defe8762efbe59a3b691ef44755f699602ec47..a2ef13ec111f7b1ee9dab535f068b0fe6c092589 100644 (file)
--- a/docs/man/grub-mknetdir.h2m
+++ b/docs/man/grub-mknetdir.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mknetdir \- prepare a GRUB netboot directory.
+[SEE ALSO]
+.BR grub-mkimage (1)

diff --git a/docs/man/grub-mkpasswd-pbkdf2.h2m b/docs/man/grub-mkpasswd-pbkdf2.h2m
index 5b2b2ef7fe3e7d46d25b10a6669822a6ff07f035..4d202f3da7e9f8bc8337807f0caf5b772e850734 100644 (file)
--- a/docs/man/grub-mkpasswd-pbkdf2.h2m
+++ b/docs/man/grub-mkpasswd-pbkdf2.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mkpasswd-pbkdf2 \- generate hashed password for GRUB
+[SEE ALSO]
+.BR grub-mkconfig (8)

diff --git a/docs/man/grub-mkrelpath.h2m b/docs/man/grub-mkrelpath.h2m
index ccc0880fa346672a6da8da669b7df6a7cca8c87e..d01f3961e3f64a3dc5abfcfb54a4798c8e58d3e8 100644 (file)
--- a/docs/man/grub-mkrelpath.h2m
+++ b/docs/man/grub-mkrelpath.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mkrelpath \- make a system path relative to its root
+[SEE ALSO]
+.BR grub-probe (8)

diff --git a/docs/man/grub-mkrescue.h2m b/docs/man/grub-mkrescue.h2m
index 5e92e0d9955f56a589da4fa12e193910b7b0882c..a427f02e3c6f2f573ca4a80efb4b5132616768e6 100644 (file)
--- a/docs/man/grub-mkrescue.h2m
+++ b/docs/man/grub-mkrescue.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-mkrescue \- make a GRUB rescue image
+[SEE ALSO]
+.BR grub-mkimage (1)

diff --git a/docs/man/grub-ofpathname.h2m b/docs/man/grub-ofpathname.h2m
index f07158cb34e1da1ba1a866177875d4ae4f2bdd3d..74b43eea039972fad8aa908806dfaa9ea2dec24c 100644 (file)
--- a/docs/man/grub-ofpathname.h2m
+++ b/docs/man/grub-ofpathname.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-ofpathname \- find OpenBOOT path for a device
+[SEE ALSO]
+.BR grub-probe (8)

diff --git a/docs/man/grub-pe2elf.h2m b/docs/man/grub-pe2elf.h2m
index 3fdb88b430542a1c3c6ed3b8db5924ce10f75082..7ca29bd703c6695444fb5415e8abcb3370ef5cde 100644 (file)
--- a/docs/man/grub-pe2elf.h2m
+++ b/docs/man/grub-pe2elf.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-pe2elf \- convert PE image to ELF
+[SEE ALSO]
+.BR grub-mkimage (1)

diff --git a/docs/man/grub-probe.h2m b/docs/man/grub-probe.h2m
index 817ba8ef680a4ebbac2d416997df906768f09e48..6e1ffdcf937ce9299b0218cc7d15bde7d4a2ff71 100644 (file)
--- a/docs/man/grub-probe.h2m
+++ b/docs/man/grub-probe.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-probe \- probe device information for GRUB
+[SEE ALSO]
+.BR grub-fstest (1)

diff --git a/docs/man/grub-reboot.h2m b/docs/man/grub-reboot.h2m
index 957e4b7979608da301be6fc41a7848acf6d3f952..e4acace65cea72bbd69c6d1ab360c52d87eecaba 100644 (file)
--- a/docs/man/grub-reboot.h2m
+++ b/docs/man/grub-reboot.h2m
@@ -1,2 +1,5 @@
 [NAME]
 grub-reboot \- set the default boot entry for GRUB, for the next boot only
+[SEE ALSO]
+.BR grub-set-default (8),
+.BR grub-editenv (1)

diff --git a/docs/man/grub-script-check.h2m b/docs/man/grub-script-check.h2m
index 39c0a3ef6e8d86f59ccff08ab4d4ea0e419f5c0b..3653682671a33edd24eac2acde98f0bac7072e08 100644 (file)
--- a/docs/man/grub-script-check.h2m
+++ b/docs/man/grub-script-check.h2m
@@ -1,2 +1,4 @@
 [NAME]
 grub-script-check \- check grub.cfg for syntax errors
+[SEE ALSO]
+.BR grub-mkconfig (8)

diff --git a/docs/man/grub-set-default.h2m b/docs/man/grub-set-default.h2m
index dd0793cfdf67ae562ed62ac490582041377011fc..7945001c15432116f4b91b676347b7f24cabcae4 100644 (file)
--- a/docs/man/grub-set-default.h2m
+++ b/docs/man/grub-set-default.h2m
@@ -1,2 +1,5 @@
 [NAME]
 grub-set-default \- set the saved default boot entry for GRUB
+[SEE ALSO]
+.BR grub-reboot (8),
+.BR grub-editenv (1)

diff --git a/docs/man/grub-setup.h2m b/docs/man/grub-setup.h2m
index e70e465a468396c3c7478a63d8dccff5671c5b7c..eebe3ef3897324e5d10f523f6a358f296ab0768a 100644 (file)
--- a/docs/man/grub-setup.h2m
+++ b/docs/man/grub-setup.h2m
@@ -1,2 +1,6 @@
 [NAME]
 grub-setup \- set up a device to boot using GRUB
+[SEE ALSO]
+.BR grub-install (8),
+.BR grub-mkimage (1),
+.BR grub-mkrescue (1)