1
0
mirror of https://github.com/moparisthebest/curl synced 2024-12-24 09:08:49 -05:00
curl/docs
Daniel Gustafsson 6381708970 checksrc: add COPYRIGHTYEAR check
Forgetting to bump the year in the copyright clause when hacking has
been quite common among curl developers, but a traditional checksrc
check isn't a good fit as it would penalize anyone hacking on January
1st (among other things). This adds a more selective COPYRIGHTYEAR
check which intends to only cover the currently hacked on changeset.

The check for updated copyright year is currently not enforced on all
files but only on files edited and/or committed locally. This is due to
the amount of files which aren't updated with their correct copyright
year at the time of their respective commit.

To further avoid running this expensive check for every developer, it
adds a new local override mode for checksrc where a .checksrc file can
be used to turn on extended warnings locally.

Closes #3303
Reviewed-by: Daniel Stenberg <daniel@haxx.se>
2018-12-03 23:13:40 +01:00
..
cmdline-opts cmdline-opts/gen.pl: define the correct varname 2018-11-26 09:56:49 +01:00
examples snprintf: renamed and we now only use msnprintf() 2018-11-23 08:26:51 +01:00
libcurl CURLOPT_WRITEFUNCTION.3: spell out that it gets called many times 2018-11-23 16:55:33 +01:00
.gitignore gitignore: Ignore man page dist files 2017-03-07 23:27:31 +01:00
BINDINGS.md URL and mailmap updates, remove an obsolete directory [ci skip] 2018-09-22 07:58:32 +00:00
BUGS BUGS: updated link to security process 2018-03-12 00:34:33 +01:00
CHECKSRC.md checksrc: add COPYRIGHTYEAR check 2018-12-03 23:13:40 +01:00
CIPHERS.md docs/CIPHERS: fix the TLS 1.3 cipher names 2018-10-27 10:46:36 +02:00
CMakeLists.txt cmake: add support for building HTML and PDF docs 2017-03-21 14:49:53 +01:00
CODE_OF_CONDUCT.md docs: Update to secure URL versions 2017-09-04 14:08:54 +00:00
CODE_STYLE.md CODE_STYLE: mention return w/o parens, but sizeof with 2018-05-14 10:47:59 +02:00
CONTRIBUTE.md spelling fixes [ci skip] 2018-10-08 19:37:40 +00:00
curl-config.1 curl-config: add --ssl-backends 2017-12-06 00:12:48 +01:00
DEPRECATE.md axtls: removed 2018-11-01 10:29:53 +01:00
FAQ axtls: removed 2018-11-01 10:29:53 +01:00
FEATURES axtls: removed 2018-11-01 10:29:53 +01:00
GOVERNANCE.md GOVERNANCE: linkify, changed some titles 2018-06-27 09:41:36 +02:00
HELP-US.md HELP-US: rename the subtitle too since the label is changed 2017-10-27 11:19:44 +02:00
HISTORY.md HISTORY: add some milestones 2018-11-09 17:46:05 +01:00
HTTP2.md winssl: be consistent in Schannel capitalization 2018-11-07 10:11:13 +01:00
HTTP-COOKIES.md docs/HTTP-COOKIES: converted to markdown 2016-03-29 08:53:40 +02:00
INSTALL INSTALL: converted to markdown => INSTALL.md 2016-10-21 15:57:29 +02:00
INSTALL.cmake whitespace fixes 2018-09-23 22:24:02 +00:00
INSTALL.md winssl: be consistent in Schannel capitalization 2018-11-07 10:11:13 +01:00
INTERNALS.md axtls: removed 2018-11-01 10:29:53 +01:00
KNOWN_BUGS host names: allow trailing dot in name resolve, then strip it 2018-11-22 13:40:51 +01:00
LICENSE-MIXING.md axtls: removed 2018-11-01 10:29:53 +01:00
MAIL-ETIQUETTE spelling fixes 2018-06-03 12:14:45 +00:00
Makefile.am whitespace fixes 2018-09-23 22:24:02 +00:00
MANUAL MANUAL: minor grammar fix 2018-10-01 07:54:58 +02:00
mk-ca-bundle.1 docs/comments: Update to secure URL versions 2017-08-08 21:41:07 +02:00
README.cmake removed execute file permission 2011-12-30 03:53:25 +01:00
README.md replace rawgit links [ci skip] 2018-10-12 21:04:37 +00:00
README.netware whitespace fixes 2018-09-23 22:24:02 +00:00
README.win32 whitespace fixes 2018-09-23 22:24:02 +00:00
RELEASE-PROCEDURE.md RELEASE-PROCEDURE: adjust the release dates 2018-10-27 15:14:51 +02:00
RESOURCES RESOURCES: update spec names 2017-12-04 09:15:39 +01:00
ROADMAP.md ROADMAP: cleanup 2017-10-28 10:54:20 +02:00
SECURITY-PROCESS.md SECURITY-PROCESS: bountygraph shuts down 2018-11-30 22:50:36 +01:00
SSL-PROBLEMS.md docs-make: have markdown files use .md 2016-08-09 14:47:20 +02:00
SSLCERTS.md SSLCERTS: improve the openssl command line 2018-08-20 14:05:28 +02:00
THANKS THANKS: 7.62.0 status 2018-10-30 17:53:59 +01:00
THANKS-filter THANKS: 7.62.0 status 2018-10-30 17:53:59 +01:00
TheArtOfHttpScripting whitespace fixes 2018-09-23 22:24:02 +00:00
TODO TODO: remove CURLOPT_DNS_USE_GLOBAL_CACHE entry 2018-11-29 12:15:04 +01:00
VERSIONS VERSIONS: now using markdown 2015-06-10 00:21:06 +02:00

curl logo

Documentation

You'll find a mix of various documentation in this directory and subdirectories, using several different formats. Some of them are not ideal for reading directly in your browser.

If you'd rather see the rendered version of the documentation, check out the curl web site's documentation section for general curl stuff or the libcurl section for libcurl related documentation.