git: f42891ebcf - main - Give base manual page higher priority than ports manual pages

The branch main has been updated by wosch:

URL: https://cgit.FreeBSD.org/doc/commit/?id=f42891ebcfffa433f1826a102014e68a284f1c0a

commit f42891ebcfffa433f1826a102014e68a284f1c0a
Author:     Wolfram Schneider <[email protected]>
AuthorDate: 2022-09-28 06:09:26 +0000
Commit:     Wolfram Schneider <[email protected]>
CommitDate: 2022-09-28 06:09:26 +0000

    Give base manual page higher priority than ports manual pages
    
    First look in the FreeBSD base manual pages (aka /usr/share/man) and then
    in FreeBSD ports (aka /usr/local/man). This avoids confusion when manual pages have
    have the same name, but are in different sections. In this case, a ports manual
    pages would win because of the higher section priority. Now, searching for "socket"
    will always show socket(2) from the base system and not socket(1) from ports
    
    PR: 264054
    Reported by: grog
---
 website/content/en/cgi/man.cgi | 50 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 45 insertions(+), 5 deletions(-)

diff --git a/website/content/en/cgi/man.cgi b/website/content/en/cgi/man.cgi
index 33774877a7..3d01c53605 100755
--- a/website/content/en/cgi/man.cgi
+++ b/website/content/en/cgi/man.cgi
@@ -59,6 +59,13 @@ my $download_streaming_caching = 0;
 #$command{'man'} = '/usr/bin/man';    # 8Bit clean man
 $command{'man'} = '/usr/local/www/bin/man.wrapper';    # set CPU limits
 
+# First look in the FreeBSD base manual pages (aka /usr/share/man) and then
+# in FreeBSD ports (aka /usr/local/man). This avoids confusion when manual pages have
+# have the same name, but are in different sections. In this case, a ports manual
+# pages would win because of the higher section priority. Now, searching for "socket"
+# will always show socket(2) from the base system and not socket(1) from ports
+my $freebsd_base_manpages_first = 1;
+
 # Config Options
 # map sections to their man command argument(s)
 %sections = (
@@ -1395,6 +1402,18 @@ sub to_filename {
     return $filename;
 }
 
+# strip ports manual pages from path
+sub manpath_without_ports {
+    my $path = shift;
+
+    my @list;
+    foreach my $p (split(/:/, $path)) {
+	push @list, $p if $p !~ /-ports-/;
+    }
+
+    return join(":", @list);
+}
+
 sub man {
     local ( $name, $section, $arch ) = @_;
     local ( $_, $title, $head, *MAN );
@@ -1502,13 +1521,15 @@ sub man {
     }
 
     @manargs = split( / /, $section );
+    my $manpath_m = "";
+
     if ($manpath) {
         if ( $manPath{$manpath} ) {
-            unshift( @manargs, ( '-M', $manPath{$manpath} ) );
+            $manpath_m = $manPath{$manpath};
             &groff_path( $manPath{$manpath} );
         }
         elsif ( $manpath{ &dec($manpath) } ) {
-            unshift( @manargs, ( '-M', $manPath{ &dec($manpath) } ) );
+            $manpath_m = $manPath{ &dec($manpath) };
             &groff_path( $manPath{ &dec($manpath) } );
         }
         else {
@@ -1524,12 +1545,31 @@ sub man {
         push( @manargs, '-t' );
     }
 
-    warn "X $command{'man'} @manargs -- x $name x\n" if $debug >= 3;
 
     push( @manargs, ( "-m", $arch ) ) if $arch;
 
-    &proc( *MAN, $command{'man'}, @manargs, "--", $name )
-      || &mydie("$0: open of $command{'man'} command failed: $!\n");
+    # search first for base manual pages, and maybe later in ports
+    if ($freebsd_base_manpages_first && $section eq "" && $manpath =~ m/ and Ports$/) {
+        warn "search for base pages first: $name\n" if $debug >= 2;
+	my @m = ("-M", &manpath_without_ports($manpath_m));
+        warn "X $command{'man'} @m @manargs -- x $name x\n" if $debug >= 3;
+        &proc( *MAN, $command{'man'}, @m,  @manargs, "--", $name )
+      	    || &mydie("$0: open of $command{'man'} command failed: $!\n");
+
+        if ( eof(MAN) ) {
+            warn "search for ports pages as well: $name\n" if $debug >= 2;
+	    @m = ("-M", $manpath_m);
+            warn "X $command{'man'} @m @manargs -- x $name x\n" if $debug >= 3;
+            &proc( *MAN, $command{'man'}, @m, @manargs, "--", $name )
+      	    	|| &mydie("$0: open of $command{'man'} command failed: $!\n");
+	}
+    } else {
+        my @m = $manpath_m ? ("-M", $manpath_m) : ();
+        warn "X $command{'man'} @m @manargs -- x $name x\n" if $debug >= 3;
+    	&proc( *MAN, $command{'man'}, @m, @manargs, "--", $name )
+      	    || &mydie("$0: open of $command{'man'} command failed: $!\n");
+    }
+
     if ( eof(MAN) ) {
         if ( $format eq "ascii" ) {
             print "Sorry, no data found for '$html_name'\n";