mirror of
https://github.com/curl/curl.git
synced 2026-08-24 22:23:58 +03:00
tidy-up: docs, comments, typos, whitespace
- GHA/windows: mention `IgnoreStandardErrorWarningFormat=true` in comment. - cmake: fix MIT/GNU GSS order in messages. - drop some exclamation marks from messages. - drop redundant ending newlines from messages. - fold/unfold where possible. - fix indent, whitespace, typos and other nits. Closes #22185
This commit is contained in:
parent
15bd6c5d4c
commit
397b8f0ec6
47 changed files with 157 additions and 150 deletions
|
|
@ -232,8 +232,7 @@ Build curl:
|
|||
% git clone --depth 1 https://github.com/curl/curl
|
||||
% cd curl
|
||||
% autoreconf -fi
|
||||
% ./configure --with-openssl=$PWD/../quiche/boringssl \
|
||||
--with-quiche=$PWD/../quiche/target/release
|
||||
% ./configure --with-openssl=$PWD/../quiche/boringssl --with-quiche=$PWD/../quiche/target/release
|
||||
% make
|
||||
% make install
|
||||
|
||||
|
|
|
|||
|
|
@ -468,7 +468,7 @@ Details via CMake
|
|||
|
||||
Examples:
|
||||
|
||||
- `-DLIBPSL_INCLUDE_DIR=/path/to/libpl/include`,
|
||||
- `-DLIBPSL_INCLUDE_DIR=/path/to/libpsl/include`,
|
||||
which directory contains `libpsl.h`.
|
||||
No ending slash or backslash is necessary.
|
||||
|
||||
|
|
@ -521,7 +521,8 @@ Available variables:
|
|||
- `HAVE_MBEDTLS_DES_CRYPT_ECB`: `mbedtls_des_crypt_ecb` present in mbedTLS <4.
|
||||
- `HAVE_OPENSSL_SRP`: `SSL_CTX_set_srp_username` present in OpenSSL (or fork).
|
||||
- `HAVE_QUICHE_CONN_SET_QLOG_FD`: `quiche_conn_set_qlog_fd` present in quiche.
|
||||
- `HAVE_RUSTLS_SUPPORTED_HPKE`: `rustls_supported_hpke` present in Rustls (unused if Rustls is detected via `pkg-config`).
|
||||
- `HAVE_RUSTLS_SUPPORTED_HPKE`: `rustls_supported_hpke` present in Rustls
|
||||
(unused if Rustls is detected via `pkg-config`).
|
||||
- `HAVE_SSL_SET0_WBIO`: `SSL_set0_wbio` present in OpenSSL (or fork).
|
||||
- `HAVE_SSL_SET1_ECH_CONFIG_LIST`: `SSL_set1_ech_config_list` present in OpenSSL (or fork).
|
||||
- `HAVE_SSL_SET_QUIC_TLS_CBS`: `SSL_set_quic_tls_cbs` in OpenSSL.
|
||||
|
|
@ -543,27 +544,37 @@ Note: These variables are internal and subject to change.
|
|||
|
||||
## Useful build targets
|
||||
|
||||
- `testdeps`: Build test dependencies (test binaries, test certificates).
|
||||
Test certificates: `build-certs` (clean with `clean-certs`)
|
||||
- `tests`: Run tests (`runtests.pl`). Customize via the `TFLAGS` environment variable, e.g. `TFLAGS=1621`.
|
||||
Other flavors: `test-am`, `test-ci`, `test-event`, `test-full`, `test-nonflaky`, `test-quiet`, `test-torture`
|
||||
- `testdeps`: Build test dependencies (test binaries,
|
||||
test certificates).
|
||||
Test certificates: `build-certs`
|
||||
(clean with `clean-certs`)
|
||||
- `tests`: Run tests (`runtests.pl`). Customize via the `TFLAGS`
|
||||
environment variable, e.g. `TFLAGS=1621`.
|
||||
Other flavors: `test-am`, `test-ci`, `test-event`,
|
||||
`test-full`, `test-nonflaky`, `test-quiet`,
|
||||
`test-torture`
|
||||
- `tt`: Build test binaries (servers, tools).
|
||||
Individual targets: `curlinfo`, `libtests`, `servers`, `tunits`, `units`
|
||||
Individual targets: `curlinfo`, `libtests`,
|
||||
`servers`, `tunits`, `units`
|
||||
- `curl-pytest`: Run tests (pytest).
|
||||
Other flavor: `curl-test-ci`
|
||||
- `curl-examples`: Build examples
|
||||
Individual targets: `curl-example-<name>`,
|
||||
where <name> is the .c filename without extension.
|
||||
- `curl-examples-build`: Build examples quickly but without the ability to run them. (for build tests)
|
||||
- `curl-examples-build`: Build examples quickly but without the ability
|
||||
to run them. (for build tests)
|
||||
- `curl-man`: Build man pages. (built by default unless disabled)
|
||||
- `curl`: Build curl tool.
|
||||
- `curl_uninstall`: Uninstall curl.
|
||||
- `curl-completion-fish`: Build shell completions for fish. (built by default if enabled)
|
||||
- `curl-completion-zsh`: Build shell completions for zsh. (built by default if enabled)
|
||||
- `curl-completion-fish`: Build shell completions for fish.
|
||||
(built by default if enabled)
|
||||
- `curl-completion-zsh`: Build shell completions for zsh.
|
||||
(built by default if enabled)
|
||||
- `curl-ca-bundle`: Build the CA bundle via `scripts/mk-ca-bundle.pl`.
|
||||
- `curl-ca-firefox`: Build the CA bundle via `scripts/firefox-db2pem.sh`.
|
||||
- `curl-lint`: Run lint checks.
|
||||
- `curl-listcats`: Generate help category constants for `src/tool_help.h` from documentation.
|
||||
- `curl-listcats`: Generate help category constants for
|
||||
`src/tool_help.h` from documentation.
|
||||
- `curl-listhelp`: Generate `src/tool_listhelp.c` from documentation.
|
||||
- `curl-optiontable`: Generate `lib/easyoptions.c` from documentation.
|
||||
|
||||
|
|
|
|||
|
|
@ -311,17 +311,17 @@ curl from the source code:
|
|||
> [!Note]
|
||||
> If an error occurs during the installation, then try:
|
||||
|
||||
- Use `cmake` to configure and/or build
|
||||
- Use `ninja` to build (much faster)
|
||||
- Using `cmake` to configure and/or build
|
||||
- Using `ninja` to build (much faster)
|
||||
- Reinstalling the required Cygwin packages from the list above without
|
||||
passing `-I` to `setup-x86_64`
|
||||
- Temporarily move Cygwin to the top of your path
|
||||
- Install all of the Cygwin build packages using
|
||||
- Temporarily moving Cygwin to the top of your path
|
||||
- Installing all of the Cygwin build packages using
|
||||
`setup-x86_64 --build-depends curl`
|
||||
|
||||
## MS-DOS
|
||||
|
||||
You can use either autotools or cmake:
|
||||
You can use either autotools or CMake:
|
||||
|
||||
```sh
|
||||
./configure \
|
||||
|
|
@ -360,7 +360,7 @@ Notes:
|
|||
|
||||
## AmigaOS
|
||||
|
||||
You can use either autotools or cmake:
|
||||
You can use either autotools or CMake:
|
||||
|
||||
```sh
|
||||
./configure \
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Get a directory listing of an FTP site:
|
|||
|
||||
curl ftp://ftp.example.com/
|
||||
|
||||
Get the all terms matching curl from a dictionary:
|
||||
Get all terms matching curl from a dictionary:
|
||||
|
||||
curl dict://dict.example.com/m:curl
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ Get a file from an SSH server using SCP using a private key
|
|||
(password-protected) to authenticate:
|
||||
|
||||
curl -u username: --key ~/.ssh/id_rsa --pass private_key_password
|
||||
scp://example.com/~/file.txt
|
||||
scp://example.com/~/file.txt
|
||||
|
||||
Get the main page from an IPv6 web server:
|
||||
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@ Release candidate tarballs are ephemeral and each such tarball is only kept
|
|||
around for a few weeks. They are provided on their dedicated webpage at:
|
||||
https://curl.se/rc/
|
||||
|
||||
The git tags for release candidate are temporary and remain set only for a
|
||||
The git tags for release candidates are temporary and remain set only for a
|
||||
limited period of time.
|
||||
|
||||
**Do not use release candidates in production**. They are work in progress.
|
||||
|
|
|
|||
|
|
@ -37,11 +37,11 @@ GN_0 = @echo " GENERATE" $@;
|
|||
GN_1 =
|
||||
GN_ = $(GN_0)
|
||||
|
||||
MANAGEN=$(top_srcdir)/scripts/managen
|
||||
MAXLINE=$(top_srcdir)/scripts/maxline
|
||||
MANAGEN = $(top_srcdir)/scripts/managen
|
||||
MAXLINE = $(top_srcdir)/scripts/maxline
|
||||
|
||||
# Maximum number of columns accepted in the ASCII version of the man page
|
||||
INCDIR=$(top_srcdir)/include
|
||||
INCDIR = $(top_srcdir)/include
|
||||
|
||||
if BUILD_DOCS
|
||||
CLEANFILES = $(MANPAGE) $(ASCIIPAGE)
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@ specify command line options and URLs mixed and in any order on the command
|
|||
line.
|
||||
|
||||
curl attempts to reuse connections when doing multiple transfers, so that
|
||||
getting many files from the same server do not use multiple connects and setup
|
||||
handshakes. This improves speed. Connection reuse can only be done for URLs
|
||||
specified for a single command line invocation and cannot be performed between
|
||||
separate curl runs.
|
||||
getting many files from the same server does not use multiple connects and
|
||||
setup handshakes. This improves speed. Connection reuse can only be done for
|
||||
URLs specified for a single command line invocation and cannot be performed
|
||||
between separate curl runs.
|
||||
|
||||
Everything provided on the command line that is not a command line option or
|
||||
its argument, curl assumes is a URL and treats it as such.
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@
|
|||
#include <curl/curl.h>
|
||||
|
||||
#ifndef CURLPIPE_MULTIPLEX
|
||||
#error "too old libcurl, cannot do HTTP/2 server push!"
|
||||
#error "too old libcurl, cannot do HTTP/2 server push"
|
||||
#endif
|
||||
|
||||
#if defined(_MSC_VER) && (_MSC_VER < 1900)
|
||||
|
|
|
|||
|
|
@ -213,7 +213,7 @@ See example below.
|
|||
~~~c
|
||||
#include <string.h> /* for strlen */
|
||||
|
||||
static const char record[]="data in a buffer";
|
||||
static const char record[] = "data in a buffer";
|
||||
|
||||
int main(void)
|
||||
{
|
||||
|
|
@ -277,7 +277,7 @@ int main(void)
|
|||
forms[0].value = file1;
|
||||
forms[1].option = CURLFORM_FILE;
|
||||
forms[1].value = file2;
|
||||
forms[2].option = CURLFORM_END;
|
||||
forms[2].option = CURLFORM_END;
|
||||
|
||||
/* Add a buffer to upload */
|
||||
curl_formadd(&post, &last,
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ int main(void)
|
|||
CURL *curl = curl_easy_init();
|
||||
if(curl) {
|
||||
CURLcode result;
|
||||
char local_buffer[1024]="data to send";
|
||||
char local_buffer[1024] = "data to send";
|
||||
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
||||
|
||||
/* size of the data to copy from the buffer and send in the request */
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue