mirror of
https://github.com/curl/curl.git
synced 2026-08-25 04:33:33 +03:00
docs: fix proselint complaints
This commit is contained in:
parent
6e0dbe84e2
commit
fda897f5a1
16 changed files with 68 additions and 71 deletions
|
|
@ -41,7 +41,7 @@ warnings are:
|
|||
more appropriate `char *name` style. The asterisk should sit right next to
|
||||
the name without a space in between.
|
||||
|
||||
- `BADCOMMAND`: There's a bad `!checksrc!` instruction in the code. See the
|
||||
- `BADCOMMAND`: There's a bad `checksrc` instruction in the code. See the
|
||||
**Ignore certain warnings** section below for details.
|
||||
|
||||
- `BANNEDFUNC`: A banned function was used. The functions sprintf, vsprintf,
|
||||
|
|
@ -56,7 +56,7 @@ warnings are:
|
|||
|
||||
- `COMMANOSPACE`: a comma without following space
|
||||
|
||||
- `COPYRIGHT`: the file is missing a copyright statement!
|
||||
- `COPYRIGHT`: the file is missing a copyright statement
|
||||
|
||||
- `CPPCOMMENTS`: `//` comment detected, that is not C89 compliant
|
||||
|
||||
|
|
@ -113,7 +113,7 @@ warnings are:
|
|||
|
||||
- `SPACESEMICOLON`: there was a space before semicolon, ` ;`.
|
||||
|
||||
- `TABS`: TAB characters are not allowed!
|
||||
- `TABS`: TAB characters are not allowed
|
||||
|
||||
- `TRAILINGSPACE`: Trailing whitespace on the line
|
||||
|
||||
|
|
@ -146,10 +146,9 @@ different ways to do this.
|
|||
### Inline ignore
|
||||
|
||||
You can control what to ignore within a specific source file by providing
|
||||
instructions to checksrc in the source code itself. You need a magic marker
|
||||
that is `!checksrc!` followed by the instruction. The instruction can ask to
|
||||
ignore a specific warning N number of times or you ignore all of them until
|
||||
you mark the end of the ignored section.
|
||||
instructions to checksrc in the source code itself. See examples below. The
|
||||
instruction can ask to ignore a specific warning N number of times or you
|
||||
ignore all of them until you mark the end of the ignored section.
|
||||
|
||||
Inline ignores are only done for that single specific source code file.
|
||||
|
||||
|
|
|
|||
|
|
@ -291,8 +291,8 @@ still fine.
|
|||
This means that all files need to have their license and copyright information
|
||||
clearly stated. Ideally by having the standard curl source code header, with
|
||||
an accurate copyright year range and the SPDX-License-Identifier included. If
|
||||
the header does not work, you can use a smaller header or as a last resort add
|
||||
the information for a specific file to the `.reuse/dep5` file.
|
||||
the header does not work, you can use a smaller header or add the information
|
||||
for a specific file to the `.reuse/dep5` file.
|
||||
|
||||
We update copyright year ranges to end on the year of the most recent change
|
||||
of the individual file.
|
||||
|
|
|
|||
|
|
@ -10,8 +10,8 @@ how your use case cannot be satisfied properly using a workaround.
|
|||
|
||||
We remove support for building curl with the NSS TLS library in August 2023.
|
||||
|
||||
- There are very few users left who use curl+NSS
|
||||
- NSS has very few users outside of curl as well (primarily Firefox)
|
||||
- There are few users left who use curl+NSS
|
||||
- NSS has few users outside of curl as well (primarily Firefox)
|
||||
- NSS is harder than ever to find documentation for
|
||||
- NSS was always "best" used with Red Hat Linux when they provided additional
|
||||
features on top of the regular NSS that is not shipped by the vanilla library
|
||||
|
|
|
|||
|
|
@ -184,11 +184,11 @@ curl_formparse() function
|
|||
August: Curl and libcurl 7.12.1
|
||||
|
||||
Public curl release number: 82
|
||||
Releases counted from the very beginning: 109
|
||||
Releases counted from the beginning: 109
|
||||
Available command line options: 96
|
||||
Available curl_easy_setopt() options: 120
|
||||
Number of public functions in libcurl: 36
|
||||
Amount of public website mirrors: 12
|
||||
Amount of public website mirrors: 12
|
||||
Number of known libcurl bindings: 26
|
||||
|
||||
2005
|
||||
|
|
|
|||
|
|
@ -253,7 +253,7 @@ development and experimenting.
|
|||
## Prerequisite(s)
|
||||
|
||||
An existing local HTTP/1.1 server that hosts files. Preferably also a few huge
|
||||
ones. You can easily create huge local files like `truncate -s=8G 8GB` - they
|
||||
ones. You can easily create huge local files like `truncate -s=8G 8GB` - they
|
||||
are huge but do not occupy that much space on disk since they are just big
|
||||
holes.
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,6 @@ Library Symbols
|
|||
|
||||
All symbols used internally in libcurl must use a `Curl_` prefix if they are
|
||||
used in more than a single file. Single-file symbols must be made static.
|
||||
Public ("exported") symbols must use a `curl_` prefix. (There are exceptions,
|
||||
but they are to be changed to follow this pattern in future versions.) Public
|
||||
API functions are marked with `CURL_EXTERN` in the public header files so
|
||||
that all others can be hidden on platforms where this is possible.
|
||||
Public ("exported") symbols must use a `curl_` prefix. Public API functions
|
||||
are marked with `CURL_EXTERN` in the public header files so that all others
|
||||
can be hidden on platforms where this is possible.
|
||||
|
|
|
|||
|
|
@ -158,7 +158,7 @@ stall and never end, so applications that cannot deal with never-ending
|
|||
transfers already need to have counter-measures established.
|
||||
|
||||
If the problem avoids the regular counter-measures when it causes a never-
|
||||
ending transfer, it might very well be a security problem.
|
||||
ending transfer, it might be a security problem.
|
||||
|
||||
## Not practically possible
|
||||
|
||||
|
|
@ -208,7 +208,7 @@ security vulnerabilities.
|
|||
|
||||
- not all systems allow the arguments to be blanked in the first place
|
||||
- since curl blanks the argument itself they will be readable for a short
|
||||
moment in time no matter what
|
||||
moment no matter what
|
||||
- virtually every argument can contain sensitive data, depending on use
|
||||
- blanking all arguments would make it impractical for users to differentiate
|
||||
curl command lines in process listings
|
||||
|
|
|
|||
|
|
@ -102,8 +102,8 @@ WebSocket myself.
|
|||
Here are the reasons why I have decided to move forward with WebSocket in
|
||||
curl **without using libWebSocket**:
|
||||
|
||||
- doxygen generated docs only makes them very hard to navigate. No tutorial,
|
||||
no clearly written explanatory pages for specific functions.
|
||||
- doxygen generated docs only makes them hard to navigate. No tutorial, no
|
||||
clearly written explanatory pages for specific functions.
|
||||
|
||||
- seems (too) tightly integrated with a specific TLS library, while we want to
|
||||
support WebSocket with whatever TLS library libcurl was already made to
|
||||
|
|
|
|||
|
|
@ -27,10 +27,10 @@ want you do reorganize them like:
|
|||
|
||||
`curl-config --cc` -o example example.c `curl-config --cflags --libs`
|
||||
|
||||
**Please** do not use the `curl.se` site as a test target for your
|
||||
libcurl applications/experiments. Even if some of the examples use that site
|
||||
as a URL at some places, it does not mean that the URLs work or that we expect
|
||||
you to actually torture our website with your tests! Thanks.
|
||||
**Please** do not use the `curl.se` site as a test target for your libcurl
|
||||
applications/experiments. Even if some of the examples use that site as a URL
|
||||
at some places, it does not mean that the URLs work or that we expect you to
|
||||
actually torture our website with your tests. Thanks.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -39,8 +39,8 @@ ABI - Application Binary Interface
|
|||
During the first seven years of libcurl releases, there have only been four
|
||||
ABI breakages.
|
||||
|
||||
We are determined to bump the SONAME as rarely as possible. Ideally, we
|
||||
never do it again.
|
||||
We are determined to bump the SONAME as rarely as possible. Ideally, we never
|
||||
do it again.
|
||||
|
||||
## Downgrades
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue