]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
managen: warn on excessively long help texts
authorDaniel Stenberg <daniel@haxx.se>
Wed, 5 Jun 2024 12:08:02 +0000 (14:08 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 5 Jun 2024 21:34:16 +0000 (23:34 +0200)
Help texts at 49 characters or longer get a warning displayed because
they make --help output uglier and we should make an effort to keep the
help texts short and succinct.

The warning is only for display, it does not break the build. That is
left for the future if necessary.

I picked 49 because the longest current text is 48.

Closes #13895

scripts/managen

index 8f16783982b35bcaadfe4202a9e6ab73b64c0aa5..a231afd94ec047cf100c788d614f5a7e71e733da 100755 (executable)
@@ -783,7 +783,9 @@ sub getshortlong {
     my $protocols;
     my $category;
     my $start = 0;
+    my $line = 0;
     while(<F>) {
+        $line++;
         if(!$start) {
             if(/^---/) {
                 $start = 1;
@@ -798,6 +800,11 @@ sub getshortlong {
         }
         elsif(/^Help: (.*)/i) {
             $help=$1;
+            my $len = length($help);
+            if($len >= 49) {
+                printf STDERR "$f:$line:1:WARN: oversized help text: %d characters\n",
+                    $len;
+            }
         }
         elsif(/^Arg: (.*)/i) {
             $arg=$1;