From 5eba0a4b376bd052ca754c98e916be34d05af9fd Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Thu, 18 Jul 2024 00:11:28 +0200 Subject: [PATCH] tests/scripts: call it 'manpage' (single word) Mostly in comments Closes #14216 --- scripts/cd2nroff | 4 ++-- scripts/managen | 6 +++--- tests/data/test1173 | 2 +- tests/data/test1705 | 2 +- tests/test1139.pl | 8 ++++---- tests/test1140.pl | 6 +++--- tests/test1173.pl | 12 ++++++------ tests/test1222.pl | 20 ++++++++++---------- tests/test1477.pl | 2 +- 9 files changed, 31 insertions(+), 31 deletions(-) diff --git a/scripts/cd2nroff b/scripts/cd2nroff index c191fcca79..91a7052baf 100755 --- a/scripts/cd2nroff +++ b/scripts/cd2nroff @@ -25,7 +25,7 @@ =begin comment -Converts a curldown file to nroff (man page). +Converts a curldown file to nroff (manpage). =end comment =cut @@ -394,7 +394,7 @@ sub single { # convert backslash-'<' or '> to just the second character $d =~ s/\\([<>])/$1/g; - # mentions of curl symbols with man pages use italics by default + # mentions of curl symbols with manpages use italics by default $d =~ s/((lib|)curl([^ ]*\(3\)))/\\fI$1\\fP/gi; # backticked becomes italics diff --git a/scripts/managen b/scripts/managen index e57053532f..03c06d1978 100755 --- a/scripts/managen +++ b/scripts/managen @@ -61,7 +61,7 @@ my $globals; my $indent = 4; -# get the long name version, return the man page string +# get the long name version, return the manpage string sub manpageify { my ($k)=@_; my $l; @@ -319,7 +319,7 @@ sub render { # remove backticks from headers $word =~ s/\`//g; - # if there is a space, it needs quotes for man page + # if there is a space, it needs quotes for manpage if(($word =~ / /) && $manpage) { $word = "\"$word\""; } @@ -1096,7 +1096,7 @@ sub mainpage { .\\" * .\\" ************************************************************************** .\\" -.\\" DO NOT EDIT. Generated by the curl project managen man page generator. +.\\" DO NOT EDIT. Generated by the curl project managen manpage generator. .\\" .TH curl 1 "$date" "curl $version" "curl Manual" HEADER diff --git a/tests/data/test1173 b/tests/data/test1173 index ff786c44bd..89b0cb5a7a 100644 --- a/tests/data/test1173 +++ b/tests/data/test1173 @@ -15,7 +15,7 @@ none -Man page syntax checks +Manpage syntax checks diff --git a/tests/data/test1705 b/tests/data/test1705 index df2b23d86f..af2263da39 100644 --- a/tests/data/test1705 +++ b/tests/data/test1705 @@ -194,7 +194,7 @@ option2.md:15:1:WARN: see-also a non-existing option: proto-default .\" * .\" ************************************************************************** .\" -.\" DO NOT EDIT. Generated by the curl project managen man page generator. +.\" DO NOT EDIT. Generated by the curl project managen manpage generator. .\" .TH curl 1 "%DATE" "curl %VERNUM" "curl Manual" .SH DESCRIPTION diff --git a/tests/test1139.pl b/tests/test1139.pl index a54cdf16dc..421af70b88 100755 --- a/tests/test1139.pl +++ b/tests/test1139.pl @@ -24,12 +24,12 @@ ########################################################################### # # Scan symbols-in-version (which is verified to be correct by test 1119), then -# verify that each option mention in there that should have its own man page +# verify that each option mention in there that should have its own manpage # actually does. # # In addition, make sure that every current option to curl_easy_setopt, # curl_easy_getinfo and curl_multi_setopt are also mentioned in their -# corresponding main (index) man page. +# corresponding main (index) manpage. # # src/tool_getparam.c lists all options curl can parse # docs/curl.1 documents all command line options @@ -227,8 +227,8 @@ while(<$r>) { close($r); ######################################################################### -# parse the curl.1 man page, extract all documented command line options -# The man page may or may not be rebuilt, so check both possible locations +# parse the curl.1 manpage, extract all documented command line options +# The manpage may or may not be rebuilt, so check both possible locations open($r, "<", "$buildroot/docs/cmdline-opts/curl.1") || open($r, "<", "$root/docs/cmdline-opts/curl.1") || die "failed getting curl.1"; my @manpage; # store all parsed parameters diff --git a/tests/test1140.pl b/tests/test1140.pl index 8e1f122985..ac06c4af30 100755 --- a/tests/test1140.pl +++ b/tests/test1140.pl @@ -24,7 +24,7 @@ ########################################################################### # # scan manpages to find basic syntactic problems such as unbalanced \f -# codes or references to non-existing curl man pages. +# codes or references to non-existing curl manpages. my $docsroot = $ARGV[0]; @@ -76,7 +76,7 @@ sub file { my $man = "$1.3"; $man =~ s/\\//g; # cut off backslashes if(!manpresent($man)) { - print "error: $f:$line: referring to non-existing man page $man\n"; + print "error: $f:$line: referring to non-existing manpage $man\n"; $errors++; } if($pre ne "I") { @@ -95,7 +95,7 @@ sub file { my $man = "$1.3"; $man =~ s/\\//g; # cut off backslashes if(!manpresent($man)) { - print "error: $f:$line: referring to non-existing man page $man\n"; + print "error: $f:$line: referring to non-existing manpage $man\n"; $errors++; } } diff --git a/tests/test1173.pl b/tests/test1173.pl index c09490ef96..584c2f1015 100755 --- a/tests/test1173.pl +++ b/tests/test1173.pl @@ -23,7 +23,7 @@ # ########################################################################### # -# Scan man page(s) and detect some simple and yet common formatting mistakes. +# Scan manpage(s) and detect some simple and yet common formatting mistakes. # # Output all deviances to stderr. @@ -137,7 +137,7 @@ sub scanmanpage { open(my $m, "<", "$file") || die "test1173.pl could not open $file"; if($file =~ /[\/\\](CURL|curl_)([^\/\\]*).3/) { - # This is a man page for libcurl. It requires an example unless it's + # This is a manpage for libcurl. It requires an example unless it's # considered deprecated. $reqex = 1 unless defined $deprecated{'CURL'.$2}; if($1 eq "CURL") { @@ -148,12 +148,12 @@ sub scanmanpage { while(<$m>) { chomp; if($_ =~ /^.so /) { - # this man page is just a referral + # this manpage is just a referral close($m); return; } if(($_ =~ /^\.SH SYNOPSIS/i) && ($reqex)) { - # this is for libcurl man page SYNOPSIS checks + # this is for libcurl manpage SYNOPSIS checks $insynop = 1; $inex = 0; } @@ -254,7 +254,7 @@ sub scanmanpage { if($optpage && $SH && ($SH !~ /^(SYNOPSIS|EXAMPLE|NAME|SEE ALSO)/i) && ($_ =~ /(.*)(CURL(OPT_|MOPT_|INFO_|SHOPT_)[A-Z0-9_]*)/)) { - # an option with its own man page, check that it is tagged + # an option with its own manpage, check that it is tagged # for linking my ($pref, $symbol) = ($1, $2); if($deprecated{$symbol}) { @@ -303,7 +303,7 @@ sub scanmanpage { } if($shcount < 3) { - print STDERR "$file:$line too few man page sections!\n"; + print STDERR "$file:$line too few manpage sections!\n"; $errors++; return; } diff --git a/tests/test1222.pl b/tests/test1222.pl index b26aea8725..93373ac133 100755 --- a/tests/test1222.pl +++ b/tests/test1222.pl @@ -25,7 +25,7 @@ ########################################################################### # # Check that the deprecated statuses of functions and enum values in header -# files, man pages and symbols-in-versions are in sync. +# files, manpages and symbols-in-versions are in sync. use strict; use warnings; @@ -45,8 +45,8 @@ my $errcode = 0; # x.yy.z Deprecated in version x.yy.z my %syminver; # Symbols-in-versions deprecations. my %hdr; # Public header files deprecations. -my %funcman; # Function man pages deprecations. -my %optman; # Option man pages deprecations. +my %funcman; # Function manpages deprecations. +my %optman; # Option manpages deprecations. # Scan header file for public function and enum values. Flag them with @@ -141,7 +141,7 @@ sub scan_header { close $h; } -# Scan function man page for options. +# Scan function manpage for options. # Each option has to be declared as ".IP