romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-08-09 10:34:19 +03:00
Code Issues Projects Releases Packages Wiki Activity

managen: wordwrap long example lines in ASCII output

Browse source 
The entire ASCII version of the manpage word wraps at a fixed column,
while example command lines can easily go wider than so.

This change now makes manage work on wrapping long example command lines
to make them look nicer. And also to avoid triggering the build error
caused by too long lines in the output.

Quoted lines cannot be wrapped, so managen now errors out if they are
"too long". With this addition, the 'maxline' script is removed as it is
no longer needed.

Closes #14543
This commit is contained in:
Daniel Stenberg 2024-08-14 13:36:20 +02:00
parent 178e8ba2d1
commit 0066d169e8
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
6 changed files with 64 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

2
scripts/Makefile.am
View file

@ -24,7 +24,7 @@
EXTRA_DIST = coverage.sh completion.pl firefox-db2pem.sh checksrc.pl \
mk-ca-bundle.pl schemetable.c cd2nroff nroff2cd cdall cd2cd managen \
dmaketgz release-tools.sh verify-release maxline
dmaketgz release-tools.sh verify-release
ZSH_FUNCTIONS_DIR = @ZSH_FUNCTIONS_DIR@
FISH_FUNCTIONS_DIR = @FISH_FUNCTIONS_DIR@

57
scripts/managen
View file

@ -58,7 +58,7 @@ my $date = strftime "%Y-%m-%d", @ts;
my $year = strftime "%Y", @ts;
my $version = "unknown";
my $globals;
my $error = 0;
my $indent = 4;
# get the long name version, return the manpage string
@ -127,7 +127,8 @@ sub justline {
sub lastline {
my ($lvl, @line) = @_;
prefixline($lvl * $indent);
$line[0] =~ s/^( +)//;
prefixline($lvl * $indent + length($1));
my $prev = 0;
for(@line) {
printf "%s%s", $prev?" ":"", $_;
@ -193,6 +194,12 @@ sub printdesc {
# quoted, do not right-justify
chomp $l;
lastline($baselvl + $lvl + 1, $l);
my $w = ($baselvl + $lvl + 1) * $indent + length($l);
if ($w > $colwidth) {
print STDERR "ERROR: $w columns is too long\n";
print STDERR "$l\n";
$error++;
}
}
else {
$para .= $l;
@ -465,6 +472,20 @@ sub render {
return @desc;
}
sub maybespace {
my ($string) = @_;
if(($string =~ /(.* )(.*)/) &&
(length($2) <= 20)) {
return $1;
}
if(($string =~ /(.*:)(.*)/) &&
(length($2) <= 20)) {
return $1;
}
return $string;
}
sub single {
my ($dir, $manpage, $f, $standalone)=@_;
my $fh;
@ -787,9 +808,37 @@ sub single {
else {
my @ex;
push @ex, "[0q]Example$s:\n";
#
# long ASCII examples are wrapped. Preferably at the last space
# before the margin. Or at a colon. Otherwise it just cuts at the
# exact boundary.
#
foreach my $e (@examples) {
$e =~ s!\$URL!https://example.com!g;
push @ex, "[0q] curl $e\n";
my $maxwidth = 60; # plus the " curl " 18 col prefix
if(length($e) > $maxwidth) {
# a long example, shorten it
my $p = substr($e, 0, $maxwidth);
$p = maybespace($p);
push @ex, "[0q] curl ".$p."\\";
$e = substr($e, length($p));
do {
my $r = substr($e, 0, $maxwidth);
if(length($e) > $maxwidth) {
$r = maybespace($r);
}
my $slash ="";
$e = substr($e, length($r));
if(length($e) > 0) {
$slash = "\\";
}
push @ex, "[0q] $r$slash" if($r);
} while(length($e));
}
else {
push @ex, "[0q] curl $e\n";
}
}
printdesc($manpage, 2, @ex);
}
@ -1224,3 +1273,5 @@ else {
indexoptions($dir, @files);
getargs($dir, $cmd, @files);
exit $error;

40
scripts/maxline
View file

@ -1,40 +0,0 @@
#!/usr/bin/env perl
#***************************************************************************
# _ _ ____ _
# Project ___| | | | _ \| |
# / __| | | | |_) | |
# | (__| |_| | _ <| |___
# \___|\___/|_| \_\_____|
#
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at https://curl.se/docs/copyright.html.
#
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
# copies of the Software, and permit persons to whom the Software is
# furnished to do so, under the terms of the COPYING file.
#
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
# KIND, either express or implied.
#
# SPDX-License-Identifier: curl
#
###########################################################################
# The provided value is the max allowed length.
my $max = $ARGV[0];
my $line = 0;
my $error;
while(<STDIN>) {
my $i = length($_);
$line++;
if($i > $max) {
print STDERR "<STDIN>:$line ERROR line too long, $i > $max\n";
print STDERR "<STDIN>:$line $_";
$error++;
}
print $_;
}
exit $error;