Fix cross references in man pages

Add small perlism to automate this.
freebsd · Jul 4, 2012 · 074f1d8 · 074f1d8
1 parent 5c9a492
commit 074f1d8
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 10 deletions.
diff --git a/pkg/Makefile b/pkg/Makefile
@@ -82,4 +82,10 @@ MAN=	pkg.8 \
 MLINKS=	pkg-delete.8 pkg-remove.8 \
 	pkg.8 pkg-static.8
 
+.PHONY: fix-xrefs
+
+fix-xrefs:
+	@./fix-xrefs ${MAN}
+
+
 .include <bsd.prog.mk>
diff --git a/pkg/fix-xrefs b/pkg/fix-xrefs
@@ -0,0 +1,52 @@
+#!/usr/bin/perl
+
+use strict;
+use warnings;
+use autodie;
+use feature qw(switch);
+
+require 5.10.1;
+
+$0 =~ s@.*/@@;
+
+MAIN:
+{
+    my @xrefs;
+    my $see_also;
+
+    @xrefs = map { (my $x = $_) =~ s/^(\S+)\.(\d)/.Xr $1 $2/; $x } @ARGV;
+
+    eval {
+        for my $man (@ARGV)
+        {
+            open READ,  "<$man";
+            open WRITE, ">$man.new";
+
+            $see_also = undef;
+
+            while (<READ>) {
+                if (/^\.Sh SEE ALSO/) {
+                    $see_also = 1;
+                    print WRITE $_;
+                    print WRITE join( " ,\n", grep { !/$man/ } @xrefs ), "\n";
+                    next;
+                }
+                if ( $see_also && /^\.Xr/ ) {
+                    next;
+                }
+                print WRITE $_;
+            }
+            close READ;
+            close WRITE;
+
+	    rename "$man.new", $man;
+        }
+    };
+    given ($@) {
+        when (undef)  { exit 0; }
+        when ('')     { exit 0; }
+        when ('open') { die "$0: open() failed -- $@\n"; }
+        default       { die "$0: Error -- $@\n"; }
+    }
+    exit 0;
+}
diff --git a/pkg/pkg-add.8 b/pkg/pkg-add.8
@@ -54,7 +54,6 @@ for further description.
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8 ,
 .Xr pkg 8 ,
 .Xr pkg-audit 8 ,
 .Xr pkg-autoremove 8 ,

diff --git a/pkg/pkg-audit.8 b/pkg/pkg-audit.8
@@ -75,7 +75,6 @@ for further description.
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8 ,
 .Xr pkg 8 ,
 .Xr pkg-add 8 ,
 .Xr pkg-autoremove 8 ,

diff --git a/pkg/pkg-check.8 b/pkg/pkg-check.8
@@ -74,7 +74,6 @@ for further description.
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8 ,
 .Xr pkg 8 ,
 .Xr pkg-add 8 ,
 .Xr pkg-audit 8 ,

diff --git a/pkg/pkg-fetch.8 b/pkg/pkg-fetch.8
@@ -87,7 +87,6 @@ for further description.
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8 ,
 .Xr pkg 8 ,
 .Xr pkg-add 8 ,
 .Xr pkg-audit 8 ,

diff --git a/pkg/pkg-info.8 b/pkg/pkg-info.8
@@ -118,7 +118,6 @@ for further description.
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8 ,
 .Xr pkg 8 ,
 .Xr pkg-add 8 ,
 .Xr pkg-audit 8 ,

diff --git a/pkg/pkg-install.8 b/pkg/pkg-install.8
@@ -115,7 +115,7 @@ See
 .Xr pkg-repo 8 ,
 .Xr pkg-rquery 8 ,
 .Xr pkg-search 8 ,
-.Xr pkg-set 8,
+.Xr pkg-set 8 ,
 .Xr pkg-shell 8 ,
 .Xr pkg-shlib 8 ,
 .Xr pkg-stats 8 ,

diff --git a/pkg/pkg-shell.8 b/pkg/pkg-shell.8
@@ -40,7 +40,6 @@ for further description.
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8 ,
 .Xr pkg 8 ,
 .Xr pkg-add 8 ,
 .Xr pkg-audit 8 ,

diff --git a/pkg/pkg-stats.8 b/pkg/pkg-stats.8
@@ -47,12 +47,12 @@ for further description.
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8 ,
 .Xr pkg 8 ,
 .Xr pkg-add 8 ,
 .Xr pkg-audit 8 ,
 .Xr pkg-autoremove 8 ,
 .Xr pkg-backup 8 ,
+.Xr pkg-check 8 ,
 .Xr pkg-clean 8 ,
 .Xr pkg-create 8 ,
 .Xr pkg-delete 8 ,

diff --git a/pkg/pkg-updating.8 b/pkg/pkg-updating.8
@@ -75,7 +75,6 @@ installed ports:
 See
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
-.Xr pkg-set 8,
 .Xr pkg 8 ,
 .Xr pkg-add 8 ,
 .Xr pkg-audit 8 ,

diff --git a/pkg/pkg-version.8 b/pkg/pkg-version.8
@@ -118,7 +118,7 @@ See
 .Xr pkg-repo 8 ,
 .Xr pkg-rquery 8 ,
 .Xr pkg-search 8 ,
-.Xr pkg-set 8,
+.Xr pkg-set 8 ,
 .Xr pkg-shell 8 ,
 .Xr pkg-shlib 8 ,
 .Xr pkg-stats 8 ,

diff --git a/pkg/pkg.conf.5 b/pkg/pkg.conf.5
@@ -160,6 +160,7 @@ file always overrides the value of an option set in the file.
 .Xr pkg-set 8 ,
 .Xr pkg-shell 8 ,
 .Xr pkg-shlib 8 ,
+.Xr pkg-stats 8 ,
 .Xr pkg-update 8 ,
 .Xr pkg-updating 8 ,
 .Xr pkg-upgrade 8 ,