#
28ca199d |
| 10-Sep-2024 |
Daniel Stenberg |
libcurl-docs: CURLINFO_LOCAL_* work for QUIC as well as TCP Also, CURLOPT_TCP_FASTOPEN is for TCP only. Closes #14852
|
#
7020bc9c |
| 10-Sep-2024 |
Daniel Stenberg |
cd2nroff: only require "added-in" for source "libcurl" To allow this script to be used by trurl easier. Closes #14844
|
#
5a488251 |
| 18-Jul-2024 |
Daniel Stenberg |
curldown: fixups - make DEFAULT sections less repetitive - make historic mentions use HISTORY - generate the protocols section on `# %PROTOCOLS%` instead of guessing
curldown: fixups - make DEFAULT sections less repetitive - make historic mentions use HISTORY - generate the protocols section on `# %PROTOCOLS%` instead of guessing where to put it - generate the availability section on `# %AVAILABILITY%` instead of guessing where to put it - make the protocols section more verbose Closes #14227
show more ...
|
#
8c1d9378 |
| 17-Jul-2024 |
Daniel Stenberg |
curldown: make 'added-in:' a mandatory header field - generate AVAILABILITY manpage sections automatically - for consistent wording - allows us to double-check against other d
curldown: make 'added-in:' a mandatory header field - generate AVAILABILITY manpage sections automatically - for consistent wording - allows us to double-check against other documumentation (symbols-in-versions etc) - enables proper automation/scripting based on this data - lots of them were wrong or missing in the manpages - several of them repeated (sometimes mismatching) backend support info Add test 1488 to verify "added-in" version numbers against symbols-in-versions. Closes #14217
show more ...
|
#
5eba0a4b |
| 17-Jul-2024 |
Daniel Stenberg |
tests/scripts: call it 'manpage' (single word) Mostly in comments Closes #14216
|
#
69b6c105 |
| 12-Jun-2024 |
Daniel Stenberg |
cd2nroff: convert two warnings to errors Since the warnings tend to get missed too easily and these are problems we rather want addressed than letting slide. Closes #13929
|
#
24b66a1d |
| 28-May-2024 |
Daniel Stenberg |
cd2nroff: use an empty "##" to signal end of .IP sequence Like when we list a series of options and then want to add "normal" text again afterwards. Without this, the indentatio
cd2nroff: use an empty "##" to signal end of .IP sequence Like when we list a series of options and then want to add "normal" text again afterwards. Without this, the indentation level wrongly continues even after the final "##" header, making following text wrongly appear to belong to the header above. Adjusted several curldown files to use this. Fixes #13803 Reported-by: Jay Satiro Closes #13806
show more ...
|
#
afdd1129 |
| 30-Mar-2024 |
Daniel Stenberg |
cd2nroff/manage: use UTC when SOURCE_DATE_EPOCH is set Make them independent of the TZ setting. Also set a date string like YYYY-MM-DD to avoid a local month name in the date. R
cd2nroff/manage: use UTC when SOURCE_DATE_EPOCH is set Make them independent of the TZ setting. Also set a date string like YYYY-MM-DD to avoid a local month name in the date. Reported-by: Carlos Henrique Lima Melara Fixes #13242 Closes #13243
show more ...
|
#
e3fe0200 |
| 22-Mar-2024 |
Daniel Stenberg |
docs/libcurl: generate PROTOCOLS from meta-data Remove the PROTOCOLS section from the source files completely and instead generate them based on the header data in the curldown files.
docs/libcurl: generate PROTOCOLS from meta-data Remove the PROTOCOLS section from the source files completely and instead generate them based on the header data in the curldown files. It also generates TLS backend information for options marked for TLS as protocol. Closes #13175
show more ...
|
#
c5775007 |
| 21-Mar-2024 |
Daniel Stenberg |
docs/libcurl: add TLS backend info for all TLS options All man pages that are listed to be for TLS now must also specify exactly what TLS backends the option works for, or use All if the
docs/libcurl: add TLS backend info for all TLS options All man pages that are listed to be for TLS now must also specify exactly what TLS backends the option works for, or use All if they all work. cd2nroff makes sure this is done and that the listed backends exist. Closes #13168
show more ...
|
#
b935fd4a |
| 21-Mar-2024 |
Daniel Stenberg |
docs: make each libcurl man specify protocol(s) The mandatory header now has a mandatory list of protocols for which the manpage is relevant. Most man pages already has a "PROTO
docs: make each libcurl man specify protocol(s) The mandatory header now has a mandatory list of protocols for which the manpage is relevant. Most man pages already has a "PROTOCOLS" section, but this introduces a stricter way to specify the relevant protocols. cd2nroff verifies that at least one protocol is mentioned (which can be `*`). This information is not used just yet, but A) the PROTOCOLS section can now instead get generated and get a unified wording across all manpages and B) this allows us to more reliably filter/search for protocol specific manpages/options. Closes #13166
show more ...
|
#
f03c8563 |
| 04-Mar-2024 |
Daniel Stenberg |
docs: ascii version of manpage without nroff Create ASCII version of manpage without nroff - build src/tool_hugegelp.c from the ascii manpage - move the the manpage and the as
docs: ascii version of manpage without nroff Create ASCII version of manpage without nroff - build src/tool_hugegelp.c from the ascii manpage - move the the manpage and the ascii version build to docs/cmdline-opts - remove all use of nroff from the build process - should make the build entirely reproducible (by avoiding nroff) - partly reverts 2620aa9 to build libcurl option man pages one by one in cmake because the appveyor builds got all crazy until I did The ASCII version of the manpage - is built with gen.pl, just like the manpage is - has a right-justified column making the appearance similar to the previous version - uses a 4-space indent per level (instead of the old version's 7) - does not do hyphenation of words (which nroff does) History We first made the curl build use nroff for building the hugehelp file in December 1998, for curl 5.2. Closes #13047
show more ...
|
#
d0968093 |
| 23-Feb-2024 |
Daniel Stenberg |
cd2nroff: gen: make `\>` in input to render as plain '>' in output The same (copy and pasted) fix/mistake as in gen.pl
|
#
50f65b4e |
| 19-Feb-2024 |
Daniel Stenberg |
cd2nroff: remove backticks from titles
|
#
d94733b4 |
| 05-Feb-2024 |
Daniel Stenberg |
docs: make curldown do angle brackets like markdown Make sure we use \< and \> in markdown all over so that it renders correctly, on GitHub and elsewhere. cd2nroff now outputs a warning
docs: make curldown do angle brackets like markdown Make sure we use \< and \> in markdown all over so that it renders correctly, on GitHub and elsewhere. cd2nroff now outputs a warning if it finds an unescaled angle bracket. Ref: #12854 Closes #12869
show more ...
|
#
f1041adf |
| 29-Jan-2024 |
Jay Satiro |
cd2nroff: use perl 'strict' and 'warnings' - Use strict and warnings pragmas. - If open() fails then show the reason. - Set STDIN io layer :crlf so that input is properly r
cd2nroff: use perl 'strict' and 'warnings' - Use strict and warnings pragmas. - If open() fails then show the reason. - Set STDIN io layer :crlf so that input is properly read on Windows. - When STDIN is used as input, the filename $f is now set to "STDIN". Various error messages in single() use $f for the filename and this way it is not undefined when STDIN. Closes https://github.com/curl/curl/pull/12819
show more ...
|
#
3e57bc2a |
| 29-Jan-2024 |
Daniel Stenberg |
cd2nroff: fix duplicate output issue Assisted-by: Jay Satiro Fixes https://github.com/curl/curl-www/issues/321 Closes #12818
|
#
2620aa93 |
| 23-Jan-2024 |
Viktor Szakats |
cmake: speed up curldown processing, enable by default - cmake: enable `BUILD_DOCS` by default (this controls converting and installing `.3` files from `.md` sources) - cmake:
cmake: speed up curldown processing, enable by default - cmake: enable `BUILD_DOCS` by default (this controls converting and installing `.3` files from `.md` sources) - cmake: speed up generating `.3` files by using a single command per directory, instead of a single command per file. This reduces external commands by about a thousand. (There remains some CMake logic kicking in resulting in 500 -one per file- external `-E touch_nocreate` calls.) - cd2nroff: add ability to process multiple input files. - cd2nroff: add `-k` option to use the source filename to form the output filename. (instead of the default in-file `Title:` line.) Follow-up to 3f08d80b2244524646ce86915c585509ac54fb4c Follow-up to ea0b575dab86a3c44dd1d547dc500276266aa382 #12753 Follow-up to eefcc1bda4bccd800f5a56a0fe17a2f44a96e88b #12730 Closes #12762
show more ...
|
#
eefcc1bd |
| 17-Jan-2024 |
Daniel Stenberg |
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
show more ...
|