46429d6f44
Viktor Szakats
2025-12-11
Subject
GHA/checkdocs: re-enable proselint, update setup, fix issues found
Binary
No binary (build failed)
Architecture & Compiler Flags
—
Build Log
(log yok)
Commit Diff GitHub →
.github/scripts/requirements-proselint.txt +5 -0.github/workflows/checkdocs.yml +51 -53docs/HTTP3.md +1 -1docs/INFRASTRUCTURE.md +2 -2docs/cmdline-opts/form.md +1 -1docs/cmdline-opts/ssl.md +1 -2docs/cmdline-opts/upload-flags.md +1 -1docs/internals/CODE_STYLE.md +2 -2docs/libcurl/opts/CURLOPT_USE_SSL.md +1 -1docs/tests/FILEFORMAT.md +3 -4
.github/scripts/requirements-proselint.txt+5 -0
| @@ -0,0 +1,5 @@ | |
| + | # Copyright (C) Daniel Stenberg, <[email protected]>, et al. |
| + | # |
| + | # SPDX-License-Identifier: curl |
| + | |
| + | proselint==0.16.0 |
.github/workflows/checkdocs.yml+51 -53
| @@ -35,59 +35,57 @@ concurrency: | |
| permissions: {} | |
| jobs: | |
| - | # proselint: |
| - | # name: 'proselint' |
| - | # runs-on: ubuntu-latest |
| - | # steps: |
| - | # - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 |
| - | # with: |
| - | # persist-credentials: false |
| - | # |
| - | # - name: 'install prereqs' |
| - | # run: | |
| - | # sudo rm -f /etc/apt/sources.list.d/microsoft-prod.list |
| - | # sudo apt-get -o Dpkg::Use-Pty=0 update |
| - | # sudo rm -f /var/lib/man-db/auto-update |
| - | # sudo apt-get -o Dpkg::Use-Pty=0 install python3-proselint |
| - | # |
| - | # # config file help: https://github.com/amperser/proselint/ |
| - | # - name: 'create proselint config' |
| - | # run: | |
| - | # cat <<JSON > ~/.proselintrc.json |
| - | # { |
| - | # "checks": { |
| - | # "typography.diacritical_marks": false, |
| - | # "typography.symbols": false, |
| - | # "annotations.misc": false, |
| - | # "security.password": false, |
| - | # "misc.annotations": false |
| - | # } |
| - | # } |
| - | # JSON |
| - | # |
| - | # - name: 'trim headers off all *.md files' |
| - | # run: git ls-files '*.md' -z | xargs -0 -n1 .github/scripts/trimmarkdownheader.pl |
| - | # |
| - | # - name: 'check prose' |
| - | # run: git ls-files '*.md' -z | grep -Evz 'CHECKSRC\.md|DISTROS\.md|curl_mprintf\.md|CURLOPT_INTERFACE\.md|interface\.md' | xargs -0 proselint -- README |
| - | # |
| - | # # This is for CHECKSRC and files with aggressive exclamation mark needs |
| - | # - name: 'create second proselint config' |
| - | # run: | |
| - | # cat <<JSON > ~/.proselintrc.json |
| - | # { |
| - | # "checks": { |
| - | # "typography.diacritical_marks": false, |
| - | # "typography.symbols": false, |
| - | # "typography.exclamation": false, |
| - | # "lexical_illusions.misc": false, |
| - | # "annotations.misc": false |
| - | # } |
| - | # } |
| - | # JSON |
| - | # |
| - | # - name: 'check special prose' |
| - | # run: proselint docs/internals/CHECKSRC.md docs/libcurl/curl_mprintf.md docs/libcurl/opts/CURLOPT_INTERFACE.md docs/cmdline-opts/interface.md |
| + | # config file help: https://github.com/amperser/proselint/ |
| + | proselint: |
| + | name: 'proselint' |
| + | runs-on: ubuntu-latest |
| + | steps: |
| + | - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 |
| + | with: |
| + | persist-credentials: false |
| + | |
| + | - name: 'install prereqs' |
| + | run: | |
| + | python3 -m venv ~/venv |
| + | ~/venv/bin/pip --disable-pip-version-check --no-input --no-cache-dir install --progress-bar off --prefer-binary -r .github/scripts/requirements-proselint.txt |
| + | |
| + | - name: 'trim headers off all *.md files' |
| + | run: git ls-files '*.md' -z | xargs -0 -n1 .github/scripts/trimmarkdownheader.pl |
| + | |
| + | - name: 'check prose' |
| + | run: | |
| + | cat <<JSON > ~/.proselintrc.json |
| + | { |
| + | "checks": { |
| + | "annotations.misc": false, |
| + | "lexical_illusions": false, |
| + | "misc.annotations": false, |
| + | "redundancy.misc.garner": false, |
| + | "security.password": false, |
| + | "spelling.ve_of": false, |
| + | "typography.diacritical_marks": false, |
| + | "typography.symbols": false |
| + | } |
| + | } |
| + | JSON |
| + | source ~/venv/bin/activate |
| + | git ls-files README '*.md' -z | grep -Evz '(CHECKSRC|DISTROS|CURLOPT_INTERFACE|interface)\.md' | xargs -0 proselint check -- |
| + | |
| + | - name: 'check special prose' # For CHECKSRC and files with aggressive exclamation mark needs |
| + | run: | |
| + | cat <<JSON > ~/.proselintrc.json |
| + | { |
| + | "checks": { |
| + | "annotations.misc": false, |
| + | "lexical_illusions": false, |
| + | "typography.diacritical_marks": false, |
| + | "typography.punctuation.exclamation": false, |
| + | "typography.symbols": false |
| + | } |
| + | } |
| + | JSON |
| + | source ~/venv/bin/activate |
| + | proselint check docs/internals/CHECKSRC.md docs/libcurl/opts/CURLOPT_INTERFACE.md docs/cmdline-opts/interface.md |
| pyspelling: | |
| name: 'pyspelling' | |
docs/HTTP3.md+1 -1
| @@ -317,7 +317,7 @@ See this [list of public HTTP/3 servers](https://bagder.github.io/HTTP3-test/) | |
| ### HTTPS eyeballing | |
| With option `--http3` curl attempts earlier HTTP versions as well should the | |
| - | connect attempt via HTTP/3 not succeed "fast enough". This strategy is similar |
| + | connect attempt via HTTP/3 fail "fast enough". This strategy is similar |
| to IPv4/6 happy eyeballing where the alternate address family is used in | |
| parallel after a short delay. | |
docs/INFRASTRUCTURE.md+2 -2
| @@ -60,7 +60,7 @@ account. | |
| We regularly run our code through the [Coverity static code | |
| analyzer](https://scan.coverity.com/) thanks to them offering this service to | |
| - | us for free. |
| + | us free of charge. |
| ## CodeSonar | |
| @@ -76,7 +76,7 @@ domain names, including `curl.se` and `curl.dev`. Daniel Stenberg owns these | |
| domain names. | |
| Until a few years ago, the curl website was present at `curl.haxx.se`. The | |
| - | `haxx.se` domain is owned by Haxx AB, administrated by Daniel Stenberg. The |
| + | `haxx.se` domain is owned by Haxx AB, administered by Daniel Stenberg. The |
| curl.haxx.se name is meant to keep working and be redirecting to curl.se for | |
| the foreseeable future. | |
docs/cmdline-opts/form.md+1 -1
| @@ -127,7 +127,7 @@ text file: | |
| curl -F '=(;type=multipart/alternative' \ | |
| -F '=plain text message' \ | |
| -F '= <body>HTML message</body>;type=text/html' \ | |
| - | -F '=)' -F '[email protected]' ... smtp://example.com |
| + | -F '=)' -F '[email protected]' ... smtp://example.com |
| Data can be encoded for transfer using encoder=. Available encodings are | |
| *binary* and *8bit* that do nothing else than adding the corresponding | |
docs/cmdline-opts/ssl.md+1 -2
| @@ -28,8 +28,7 @@ different levels of encryption required. | |
| This option is handled in LDAP (added in 7.81.0). It is fully supported by the | |
| OpenLDAP backend and ignored by the generic ldap backend. | |
| - | Please note that a server may close the connection if the negotiation does |
| - | not succeed. |
| + | Please note that a server may close the connection if the negotiation fails. |
| This option was formerly known as --ftp-ssl (added in 7.11.0). That option | |
| name can still be used but might be removed in a future version. | |
docs/cmdline-opts/upload-flags.md+1 -1
| @@ -21,5 +21,5 @@ specified as either a single flag value or a comma-separated list | |
| of flag values. These values are case-sensitive and may be negated | |
| by prepending them with a '-' character. Currently the following | |
| flag values are accepted: answered, deleted, draft, flagged, and | |
| - | seen. The currently-accepted flag values are used to set flags on |
| + | seen. The currently accepted flag values are used to set flags on |
| IMAP uploads. | |
docs/internals/CODE_STYLE.md+2 -2
| @@ -24,8 +24,8 @@ need to copy the style already used in the source code and there are no | |
| particularly unusual rules in our set of rules. | |
| We also work hard on writing code that are warning-free on all the major | |
| - | platforms and in general on as many platforms as possible. Code that obviously |
| - | causes warnings is not accepted as-is. |
| + | platforms and in general on as many platforms as possible. Code that causes |
| + | warnings is not accepted as-is. |
| ## Readability | |
docs/libcurl/opts/CURLOPT_USE_SSL.md+1 -1
| @@ -45,7 +45,7 @@ do not attempt to use SSL. | |
| ## CURLUSESSL_TRY | |
| Try using SSL, proceed as normal otherwise. Note that server may close the | |
| - | connection if the negotiation does not succeed. |
| + | connection if the negotiation fails. |
| ## CURLUSESSL_CONTROL | |
docs/tests/FILEFORMAT.md+3 -4
| @@ -11,10 +11,9 @@ XML. All data for a single test case resides in a single ASCII file. Labels | |
| mark the beginning and the end of all sections, and each label must be written | |
| in its own line. Comments are either XML-style (enclosed with `<!--` and | |
| `-->`) or shell script style (beginning with `#`) and must appear on their own | |
| - | lines and not alongside actual test data. Most test data files are |
| - | syntactically-valid XML (a few files are not); lack of support for character |
| - | entities is a big difference but macros like %CR fill that particular role |
| - | here. |
| + | lines and not alongside actual test data. Test data files are syntactically |
| + | valid XML; lack of support for character entities is a big difference but macros |
| + | like %CR fill that particular role here. |
| Each test case source exists as a file matching the format | |
| `tests/data/testNUM`, where `NUM` is the unique test number, and must begin | |