--- /dev/null
+#!/usr/bin/perl
+# Copyright (C) 2022 Daniel Stenberg, <daniel@haxx.se>, et al.
+#
+# SPDX-License-Identifier: curl
+#
+# Input: a libcurl nroff man page
+# Output: the same file, minus the SYNOPSIS and the EXAMPLE sections
+#
+
+my $f = $ARGV[0];
+my $o = $ARGV[1];
+
+open(F, "<$f") or die;
+open(O, ">$o") or die;
+
+my $ignore = 0;
+while(<F>) {
+ if($_ =~ /^.SH (SYNOPSIS|EXAMPLE|\"SEE ALSO\"|SEE ALSO)/) {
+ $ignore = 1;
+ }
+ elsif($ignore && ($_ =~ /^.SH/)) {
+ $ignore = 0;
+ }
+ elsif(!$ignore) {
+ # filter out mentioned CURLE_ names
+ $_ =~ s/CURL(M|SH|U|H)code//g;
+ $_ =~ s/CURL_(READ|WRITE)FUNC_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_CSELECT_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_DISABLE_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_FORMADD_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_HET_DEFAULT//g;
+ $_ =~ s/CURL_IPRESOLVE_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_PROGRESSFUNC_CONTINUE//g;
+ $_ =~ s/CURL_REDIR_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_RTSPREQ_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_TIMECOND_[A-Z0-9_]*//g;
+ $_ =~ s/CURL_VERSION_[A-Z0-9_]*//g;
+ $_ =~ s/CURLALTSVC_[A-Z0-9_]*//g;
+ $_ =~ s/CURLAUTH_[A-Z0-9_]*//g;
+ $_ =~ s/CURLE_[A-Z0-9_]*//g;
+ $_ =~ s/CURLFORM_[A-Z0-9_]*//g;
+ $_ =~ s/CURLFTP_[A-Z0-9_]*//g;
+ $_ =~ s/CURLFTPAUTH_[A-Z0-9_]*//g;
+ $_ =~ s/CURLFTPMETHOD_[A-Z0-9_]*//g;
+ $_ =~ s/CURLFTPSSL_[A-Z0-9_]*//g;
+ $_ =~ s/CURLGSSAPI_[A-Z0-9_]*//g;
+ $_ =~ s/CURLHEADER_[A-Z0-9_]*//g;
+ $_ =~ s/CURLINFO_[A-Z0-9_]*//g;
+ $_ =~ s/CURLM_[A-Z0-9_]*//g;
+ $_ =~ s/CURLMIMEOPT_[A-Z0-9_]*//g;
+ $_ =~ s/CURLMOPT_[A-Z0-9_]*//g;
+ $_ =~ s/CURLOPT_[A-Z0-9_]*//g;
+ $_ =~ s/CURLPIPE_[A-Z0-9_]*//g;
+ $_ =~ s/CURLPROTO_[A-Z0-9_]*//g;
+ $_ =~ s/CURLPROXY_[A-Z0-9_]*//g;
+ $_ =~ s/CURLPX_[A-Z0-9_]*//g;
+ $_ =~ s/CURLSHE_[A-Z0-9_]*//g;
+ $_ =~ s/CURLSHOPT_[A-Z0-9_]*//g;
+ $_ =~ s/CURLSSH_[A-Z0-9_]*//g;
+ $_ =~ s/CURLSSLBACKEND_[A-Z0-9_]*//g;
+ $_ =~ s/CURLU_[A-Z0-9_]*//g;
+ $_ =~ s/CURLUE_[A-Z0-9_]*//g;
+ $_ =~ s/CURLUPART_[A-Z0-9_]*//g;
+ $_ =~ s/CURLUSESSL_[A-Z0-9_]*//g;
+ $_ =~ s/curl_global_(init_mem|sslset|cleanup)//g;
+ $_ =~ s/curl_(strequal|strnequal|formadd|waitfd|formget|getdate|formfree)//g;
+ $_ =~ s/curl_easy_(nextheader|duphandle)//g;
+ $_ =~ s/curl_multi_fdset//g;
+ $_ =~ s/curl_mime_(subparts|addpart|filedata|data_cb)//g;
+ $_ =~ s/curl_ws_(send|recv|meta)//g;
+ $_ =~ s/curl_url_(dup)//g;
+ $_ =~ s/libcurl-env//g;
+ $_ =~ s/(^|\W)((tftp|https|http|ftp):\/\/[a-z0-9\-._~%:\/?\#\[\]\@!\$&'()*+,;=]+)//gi;
+ print O $_;
+ }
+}
+close(F);
+close(O);
+
--- /dev/null
+# Copyright (C) 2022 Daniel Stenberg, <daniel@haxx.se>, et al.
+#
+# SPDX-License-Identifier: curl
+
+name: spell
+on:
+ push:
+ branches:
+ - master
+ paths:
+ - '**.md'
+ - '**.3'
+ - '**.1'
+ - '.github/**'
+ pull_request:
+ branches:
+ - master
+ paths:
+ - '**.md'
+ - '**.3'
+ - '**.1'
+ - '.github/**'
+
+jobs:
+ check:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: install pandoc
+ run: sudo apt-get install pandoc
+
+ - name: strip "uncheckable" sections from .3 pages
+ run: find docs -name "*.3" -size +40c | sed 's/\.3//' | xargs -t -n1 -I OO ./.github/scripts/cleanspell.pl OO.3 OO.33
+
+ - name: convert .3 man pages to markdown
+ run: find docs -name "*.33" -size +40c | sed 's/\.33//' | xargs -t -n1 -I OO pandoc -f man -t markdown OO.33 -o OO.md
+
+ - name: convert .1 man pages to markdown
+ run: find docs -name "*.1" -size +40c | sed 's/\.1//' | xargs -t -n1 -I OO pandoc OO.1 -o OO.md
+
+ - name: setup the custom wordlist
+ run: grep -v '^#' .github/scripts/spellcheck.words > wordlist.txt
+
+ - name: setup the spellcheck config
+ run: cp .github/scripts/spellcheck.yaml .
+
+ - name: Check Spelling
+ uses: UnicornGlobal/spellcheck-github-actions@master
projects / thirdparty / curl.git / commitdiff
