]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
verify-examples.pl: verify that all man page examples compile clean
authorDaniel Stenberg <daniel@haxx.se>
Mon, 4 Dec 2023 09:50:42 +0000 (10:50 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 4 Dec 2023 09:50:42 +0000 (10:50 +0100)
.github/scripts/verify-examples.pl [new file with mode: 0755]

diff --git a/.github/scripts/verify-examples.pl b/.github/scripts/verify-examples.pl
new file mode 100755 (executable)
index 0000000..e36eb08
--- /dev/null
@@ -0,0 +1,95 @@
+#!/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
+#
+###########################################################################
+
+my @files = @ARGV;
+my $cfile = "test.c";
+my $check = "./scripts/checksrc.pl";
+
+if($files[0] eq "-h") {
+    print "Usage: verify-synopsis [man pages]\n";
+    exit;
+}
+
+sub testcompile {
+    my $rc = system("gcc -c test.c -DCURL_DISABLE_TYPECHECK -DCURL_ALLOW_OLD_MULTI_SOCKET -DCURL_DISABLE_DEPRECATION -Wunused -Werror -Wno-unused-but-set-variable -I include") >> 8;
+    return $rc;
+}
+
+sub checksrc {
+    my $rc = system("$check test.c") >> 8;
+    return $rc;
+}
+
+sub extract {
+    my($f) = @_;
+    my $syn = 0;
+    my $l = 0;
+    my $iline = 0;
+    open(F, "<$f");
+    open(O, ">$cfile");
+    print O "#include <curl/curl.h>\n";
+    print O "extern struct CURLM *multi;\n";
+    print O "extern struct CURL *easy;\n";
+    while(<F>) {
+        $iline++;
+        if(/^.SH EXAMPLE/) {
+            $syn = 1
+        }
+        elsif($syn == 1) {
+            if(/^.nf/) {
+                $syn++;
+                print O "/* !checksrc! disable UNUSEDIGNORE all */\n";
+                print O "/* !checksrc! disable COPYRIGHT all */\n";
+                print O "/* !checksrc! disable FOPENMODE all */\n";
+                printf O "#line %d \"$f\"\n", $iline+1;
+            }
+        }
+        elsif($syn == 2) {
+            if(/^.fi/) {
+                last;
+            }
+            # two backslashes become one
+            $_ =~ s/\\\\/\\/g;
+            print O $_;
+            $l++;
+        }
+    }
+    close(F);
+    close(O);
+
+    return $l;
+}
+
+my $error;
+for my $m (@files) {
+    print "Verify $m\n";
+    my $out = extract($m);
+    if($out) {
+      $error |= testcompile($m);
+      $error |= checksrc($m);
+    }
+}
+exit $error;
+