From: Daniel Stenberg <daniel@haxx.se>
Date: Tue, 1 Aug 2023 12:11:50 +0000 (+0200)
Subject: CI/spellcheck: build curl.1 and spellcheck it
X-Git-Tag: curl-8_3_0~251
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6b11d9d86b2f608b2fdac4d918f48537e034c143;p=thirdparty%2Fcurl.git

CI/spellcheck: build curl.1 and spellcheck it

Added acceptable words

Closes #11562
---

diff --git a/.github/scripts/spellcheck.words b/.github/scripts/spellcheck.words
index 7be1719b43..f598dbc02f 100644
--- a/.github/scripts/spellcheck.words
+++ b/.github/scripts/spellcheck.words
@@ -77,6 +77,7 @@ buildconf
 Caddy
 calloc
 CAPA
+capath
 CCC
 CDN
 CentOS
@@ -187,6 +188,7 @@ EBCDIC
 ECC
 ECDHE
 ECH
+ECONNREFUSED
 eCOS
 EFnet
 EGD
@@ -259,6 +261,7 @@ ggcov
 Ghedini
 Gisle
 Glesys
+globbed
 globbing
 gmail
 GnuTLS
@@ -304,9 +307,9 @@ hsts
 HTC
 html
 http
+HTTPAUTH
 httpd
 HTTPD
-HTTPAUTH
 httpget
 HttpGet
 HTTPS
@@ -325,6 +328,7 @@ ifdef
 ifdefed
 Ifdefs
 ifdefs
+IIS
 ILE
 Illumos
 IMAP
@@ -335,6 +339,7 @@ impacket
 init
 initializer
 inlined
+interop
 interoperable
 interoperates
 IoT
@@ -364,6 +369,7 @@ keepalive
 Keil
 kerberos
 Keychain
+keychain
 KiB
 kickstart
 Kirei
@@ -500,6 +506,7 @@ NEC
 Necko
 NetBSD
 netrc
+netstat
 Netware
 NFS
 nghttp
@@ -558,6 +565,7 @@ permafailing
 PINGs
 pipelining
 PKCS
+pkcs
 PKGBUILD
 PKI
 pluggable
@@ -591,6 +599,7 @@ PTR
 ptr
 punycode
 PWD
+pwd
 py
 pycurl
 pytest
@@ -608,6 +617,7 @@ RBS
 ReactOS
 README
 realloc
+Realtime
 rebase
 RECV
 recv
@@ -781,6 +791,7 @@ toolset
 toplevel
 TPF
 TrackMemory
+transcode
 Tru
 Tse
 Tsujikawa
@@ -798,9 +809,12 @@ UIDL
 Ultrix
 Unary
 unassign
+UNC
 uncompress
+unencoded
 unencrypted
 unescape
+Unglobbed
 UNICOS
 unix
 UnixSockets
@@ -826,6 +840,7 @@ USD
 userdata
 Userinfo
 userinfo
+USERPROFILE
 UTF
 UX
 valgrind
@@ -849,6 +864,7 @@ watchOS
 WAV
 WB
 web page
+WebDAV
 WebOS
 WebSocket
 WEBSOCKET
@@ -872,6 +888,7 @@ WS
 WSS
 www
 Xbox
+XDG
 xdigit
 Xilinx
 XP
diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
index 65a7da10c5..fa644a44b8 100644
--- a/.github/workflows/spellcheck.yml
+++ b/.github/workflows/spellcheck.yml
@@ -36,6 +36,12 @@ jobs:
     - name: install pandoc
       run: sudo apt-get install pandoc
 
+    - name: build curl.1
+      run: |
+         autoreconf -fi
+         ./configure --without-ssl
+         make -C docs
+
     - 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
 
@@ -45,6 +51,12 @@ jobs:
     - 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: trim the curl.1 markdown file
+      run: |
+        perl -pi -e 's/^    .*//' docs/curl.md
+        perl -pi -e 's/--[a-z0-9-]*//ig' docs/curl.md
+        perl -pi -e 's!https://[a-z0-9%/.-]*!!ig' docs/curl.md
+
     - name: setup the custom wordlist
       run: grep -v '^#' .github/scripts/spellcheck.words >  wordlist.txt