From: Daniel Stenberg Date: Sun, 31 Mar 2024 09:52:28 +0000 (+0200) Subject: reuse: add copyright + license info to individual docs/*.md files X-Git-Tag: curl-8_8_0~323 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=86d33001e4202c56874a284c619a29695d57dfd3;p=thirdparty%2Fcurl.git reuse: add copyright + license info to individual docs/*.md files Instead of use 'docs/*.md' in dep5. For clarity and avoiding a wide- matching wildcard. + Remove mention of old files from .reuse/dep5 + add info to .github/dependabot.yml + make scripts/copyright.pl warn on non-matching patterns Closes #13245 --- diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5ace4600a1..792d0f0b31 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,3 +1,7 @@ +# Copyright (C) Daniel Stenberg, , et al. +# +# SPDX-License-Identifier: curl + version: 2 updates: - package-ecosystem: "github-actions" diff --git a/.reuse/dep5 b/.reuse/dep5 index d51e5b9ce1..fd332f1487 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -8,13 +8,8 @@ Files: tests/data/test* tests/certs/* tests/stunnel.pem tests/valgrind.supp Copyright: Daniel Stenberg, , et al. License: curl -# Markdown documentation in docs/ -Files: docs/*.md -Copyright: Daniel Stenberg, , et al. -License: curl - # Docs in docs/ -Files: docs/FAQ docs/INSTALL docs/INSTALL.cmake docs/KNOWN_BUGS docs/MAIL-ETIQUETTE docs/THANKS docs/TODO docs/cmdline-opts/page-footer docs/libcurl/curl_multi_socket_all.3 docs/libcurl/curl_strnequal.3 docs/libcurl/symbols-in-versions docs/options-in-versions +Files: docs/FAQ docs/INSTALL docs/KNOWN_BUGS docs/MAIL-ETIQUETTE docs/THANKS docs/TODO docs/libcurl/symbols-in-versions docs/options-in-versions Copyright: Daniel Stenberg, , et al. License: curl @@ -89,14 +84,6 @@ Files: README Copyright: Daniel Stenberg, , et al. License: curl -Files: .github/ISSUE_TEMPLATE/bug_report.md -Copyright: Daniel Stenberg, , et al. -License: curl - Files: .mailmap Copyright: Daniel Stenberg, , et al. License: curl - -Files: .github/dependabot.yml -Copyright: Daniel Stenberg, , et al. -License: curl diff --git a/docs/ALTSVC.md b/docs/ALTSVC.md index 92343aee4d..4b5bcffcc9 100644 --- a/docs/ALTSVC.md +++ b/docs/ALTSVC.md @@ -1,3 +1,9 @@ + + # Alt-Svc curl features support for the Alt-Svc: HTTP header. diff --git a/docs/BINDINGS.md b/docs/BINDINGS.md index 060586fde2..e2580b42b6 100644 --- a/docs/BINDINGS.md +++ b/docs/BINDINGS.md @@ -1,3 +1,9 @@ + + libcurl bindings ================ diff --git a/docs/BUFQ.md b/docs/BUFQ.md index 26cfccf491..60843819ef 100644 --- a/docs/BUFQ.md +++ b/docs/BUFQ.md @@ -1,3 +1,9 @@ + + # bufq This is an internal module for managing I/O buffers. A `bufq` can be written diff --git a/docs/BUFREF.md b/docs/BUFREF.md index 9ee8fdbbee..9a8b506b56 100644 --- a/docs/BUFREF.md +++ b/docs/BUFREF.md @@ -1,3 +1,9 @@ + + # bufref This is an internal module for handling buffer references. A referenced diff --git a/docs/BUG-BOUNTY.md b/docs/BUG-BOUNTY.md index 3cb4024a31..d533af9442 100644 --- a/docs/BUG-BOUNTY.md +++ b/docs/BUG-BOUNTY.md @@ -1,3 +1,9 @@ + + # The curl bug bounty The curl project runs a bug bounty program in association with diff --git a/docs/BUGS.md b/docs/BUGS.md index 9a3a30add0..8a3ef82e9c 100644 --- a/docs/BUGS.md +++ b/docs/BUGS.md @@ -1,3 +1,9 @@ + + # BUGS ## There are still bugs diff --git a/docs/CHECKSRC.md b/docs/CHECKSRC.md index fc50045359..16eb96c75b 100644 --- a/docs/CHECKSRC.md +++ b/docs/CHECKSRC.md @@ -1,3 +1,9 @@ + + # checksrc This is the tool we use within the curl project to scan C source code and diff --git a/docs/CIPHERS.md b/docs/CIPHERS.md index 1fb8540584..d55989bfa2 100644 --- a/docs/CIPHERS.md +++ b/docs/CIPHERS.md @@ -1,3 +1,9 @@ + + # Ciphers With curl's options diff --git a/docs/CLIENT-READERS.md b/docs/CLIENT-READERS.md index dec35b3282..30a4725b19 100644 --- a/docs/CLIENT-READERS.md +++ b/docs/CLIENT-READERS.md @@ -1,3 +1,9 @@ + + # curl client readers Client readers is a design in the internals of libcurl, not visible in its public API. They were started diff --git a/docs/CLIENT-WRITERS.md b/docs/CLIENT-WRITERS.md index 47e802f121..9f7197d228 100644 --- a/docs/CLIENT-WRITERS.md +++ b/docs/CLIENT-WRITERS.md @@ -1,3 +1,9 @@ + + # curl client writers Client writers is a design in the internals of libcurl, not visible in its public API. They were started diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 1f71c387bd..5c8878189c 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + Contributor Code of Conduct =========================== diff --git a/docs/CODE_REVIEW.md b/docs/CODE_REVIEW.md index 0776d30a08..b78992a3e7 100644 --- a/docs/CODE_REVIEW.md +++ b/docs/CODE_REVIEW.md @@ -1,3 +1,9 @@ + + # How to do code reviews for curl Anyone and everyone is encouraged and welcome to review code submissions in diff --git a/docs/CODE_STYLE.md b/docs/CODE_STYLE.md index 970a3b0aec..7b2b60251f 100644 --- a/docs/CODE_STYLE.md +++ b/docs/CODE_STYLE.md @@ -1,3 +1,9 @@ + + # curl C code style Source code that has a common style is easier to read than code that uses diff --git a/docs/CONNECTION-FILTERS.md b/docs/CONNECTION-FILTERS.md index 95b6d50d7a..6b20f93de1 100644 --- a/docs/CONNECTION-FILTERS.md +++ b/docs/CONNECTION-FILTERS.md @@ -1,3 +1,9 @@ + + # curl connection filters Connection filters is a design in the internals of curl, not visible in its diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md index 6288dac90d..bffcd5a945 100644 --- a/docs/CONTRIBUTE.md +++ b/docs/CONTRIBUTE.md @@ -1,3 +1,9 @@ + + # Contributing to the curl project This document is intended to offer guidelines on how to best contribute to the diff --git a/docs/CURL-DISABLE.md b/docs/CURL-DISABLE.md index 7978ed2125..3409bec018 100644 --- a/docs/CURL-DISABLE.md +++ b/docs/CURL-DISABLE.md @@ -1,3 +1,9 @@ + + # Code defines to disable features and protocols ## `CURL_DISABLE_ALTSVC` diff --git a/docs/CURLDOWN.md b/docs/CURLDOWN.md index 8ee2f3ce4f..910438976b 100644 --- a/docs/CURLDOWN.md +++ b/docs/CURLDOWN.md @@ -1,3 +1,9 @@ + + # curldown A markdown-like syntax for libcurl man pages. diff --git a/docs/DEPRECATE.md b/docs/DEPRECATE.md index 6b6b5b46b8..27f8b288e0 100644 --- a/docs/DEPRECATE.md +++ b/docs/DEPRECATE.md @@ -1,3 +1,9 @@ + + # Items to be removed from future curl releases If any of these deprecated features is a cause for concern for you, please diff --git a/docs/DISTROS.md b/docs/DISTROS.md index 09e588c4f1..dd7a5b5743 100644 --- a/docs/DISTROS.md +++ b/docs/DISTROS.md @@ -1,3 +1,9 @@ + + # curl distros diff --git a/docs/DYNBUF.md b/docs/DYNBUF.md index 3f63ec7e47..01fe332ab6 100644 --- a/docs/DYNBUF.md +++ b/docs/DYNBUF.md @@ -1,3 +1,9 @@ + + # dynbuf This is the internal module for creating and handling "dynamic buffers". This diff --git a/docs/EARLY-RELEASE.md b/docs/EARLY-RELEASE.md index 3e9a679ac3..e66dbbd444 100644 --- a/docs/EARLY-RELEASE.md +++ b/docs/EARLY-RELEASE.md @@ -1,3 +1,9 @@ + + # How to determine if an early patch release is warranted In the curl project we do releases every 8 weeks. Unless we break the cycle diff --git a/docs/EXPERIMENTAL.md b/docs/EXPERIMENTAL.md index ee26ac1106..4e781ecba7 100644 --- a/docs/EXPERIMENTAL.md +++ b/docs/EXPERIMENTAL.md @@ -1,3 +1,9 @@ + + # Experimental Some features and functionality in curl and libcurl are considered diff --git a/docs/FEATURES.md b/docs/FEATURES.md index bae38fb851..3121fcc906 100644 --- a/docs/FEATURES.md +++ b/docs/FEATURES.md @@ -1,3 +1,9 @@ + + # Features -- what curl can do ## curl tool diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md index 09723c4d0b..4ab52a9a01 100644 --- a/docs/GOVERNANCE.md +++ b/docs/GOVERNANCE.md @@ -1,3 +1,9 @@ + + # Decision making in the curl project A rough guide to how we make decisions and who does what. diff --git a/docs/HELP-US.md b/docs/HELP-US.md index 15996d0462..0619aec531 100644 --- a/docs/HELP-US.md +++ b/docs/HELP-US.md @@ -1,3 +1,9 @@ + + # How to get started helping out in the curl project We are always in need of more help. If you are new to the project and are diff --git a/docs/HISTORY.md b/docs/HISTORY.md index d28217ca6f..bcc472cd9f 100644 --- a/docs/HISTORY.md +++ b/docs/HISTORY.md @@ -1,3 +1,9 @@ + + How curl Became Like This ========================= diff --git a/docs/HSTS.md b/docs/HSTS.md index c1f433b281..85140ab30f 100644 --- a/docs/HSTS.md +++ b/docs/HSTS.md @@ -1,3 +1,9 @@ + + # HSTS support HTTP Strict-Transport-Security. Added as experimental in curl diff --git a/docs/HTTP-COOKIES.md b/docs/HTTP-COOKIES.md index 174c4f536d..38432d273f 100644 --- a/docs/HTTP-COOKIES.md +++ b/docs/HTTP-COOKIES.md @@ -1,3 +1,9 @@ + + # HTTP Cookies ## Cookie overview diff --git a/docs/HTTP2.md b/docs/HTTP2.md index 1d6575b54f..aed06f5488 100644 --- a/docs/HTTP2.md +++ b/docs/HTTP2.md @@ -1,3 +1,9 @@ + + HTTP/2 with curl ================ diff --git a/docs/HTTP3.md b/docs/HTTP3.md index 783ab101ff..1a528a8c1b 100644 --- a/docs/HTTP3.md +++ b/docs/HTTP3.md @@ -1,3 +1,9 @@ + + # HTTP3 (and QUIC) ## Resources diff --git a/docs/HYPER.md b/docs/HYPER.md index 1e47c42372..84b37593d4 100644 --- a/docs/HYPER.md +++ b/docs/HYPER.md @@ -1,3 +1,9 @@ + + # Hyper Hyper is a separate HTTP library written in Rust. curl can be told to use this diff --git a/docs/INSTALL-CMAKE.md b/docs/INSTALL-CMAKE.md index a606fcb21c..74c8094656 100644 --- a/docs/INSTALL-CMAKE.md +++ b/docs/INSTALL-CMAKE.md @@ -1,10 +1,8 @@ - _ _ ____ _ - ___| | | | _ \| | - / __| | | | |_) | | - | (__| |_| | _ <| |___ - \___|\___/|_| \_\_____| + # Building with CMake diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 7971b1abaa..eae54d5215 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,3 +1,9 @@ + + # how to install curl and libcurl ## Installing Binary Packages diff --git a/docs/INTERNALS.md b/docs/INTERNALS.md index b1a095fe9e..827fcfd36d 100644 --- a/docs/INTERNALS.md +++ b/docs/INTERNALS.md @@ -1,3 +1,9 @@ + + # curl internals The canonical libcurl internals documentation is now in the [everything diff --git a/docs/IPFS.md b/docs/IPFS.md index 65c0f5dade..82dae94399 100644 --- a/docs/IPFS.md +++ b/docs/IPFS.md @@ -1,3 +1,9 @@ + + # IPFS For an overview about IPFS, visit the [IPFS project site](https://ipfs.tech/). diff --git a/docs/MANUAL.md b/docs/MANUAL.md index 3ce869413f..03de0eb397 100644 --- a/docs/MANUAL.md +++ b/docs/MANUAL.md @@ -1,3 +1,9 @@ + + # curl tutorial ## Simple Usage diff --git a/docs/MQTT.md b/docs/MQTT.md index 35c4e7699b..a1bc4b349e 100644 --- a/docs/MQTT.md +++ b/docs/MQTT.md @@ -1,3 +1,9 @@ + + # MQTT in curl ## Usage diff --git a/docs/NEW-PROTOCOL.md b/docs/NEW-PROTOCOL.md index b70caa9445..be7fc98465 100644 --- a/docs/NEW-PROTOCOL.md +++ b/docs/NEW-PROTOCOL.md @@ -1,3 +1,9 @@ + + # Adding a new protocol? Every once in a while, someone comes up with the idea of adding support for yet diff --git a/docs/PARALLEL-TRANSFERS.md b/docs/PARALLEL-TRANSFERS.md index c086f14aba..08aac544a7 100644 --- a/docs/PARALLEL-TRANSFERS.md +++ b/docs/PARALLEL-TRANSFERS.md @@ -1,3 +1,9 @@ + + # Parallel transfers curl 7.66.0 introduced support for doing multiple transfers simultaneously; in diff --git a/docs/README.md b/docs/README.md index 59f4bd147b..22d96ea9bd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,9 @@ + + ![curl logo](https://curl.se/logo/curl-logo.svg) # Documentation diff --git a/docs/RELEASE-PROCEDURE.md b/docs/RELEASE-PROCEDURE.md index 4f662ce868..20b6cfc11c 100644 --- a/docs/RELEASE-PROCEDURE.md +++ b/docs/RELEASE-PROCEDURE.md @@ -1,3 +1,9 @@ + + curl release procedure - how to do a release ============================================ diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md index 4642938348..dbebdf6358 100644 --- a/docs/ROADMAP.md +++ b/docs/ROADMAP.md @@ -1,3 +1,9 @@ + + # curl the next few years - perhaps Roadmap of things Daniel Stenberg wants to work on next. It is intended to diff --git a/docs/RUSTLS.md b/docs/RUSTLS.md index 6c270bfa4b..cf32afc5e1 100644 --- a/docs/RUSTLS.md +++ b/docs/RUSTLS.md @@ -1,3 +1,9 @@ + + # Rustls [Rustls is a TLS backend written in Rust](https://docs.rs/rustls/). Curl can diff --git a/docs/SECURITY-ADVISORY.md b/docs/SECURITY-ADVISORY.md index 8d908a8ca5..efb0e04934 100644 --- a/docs/SECURITY-ADVISORY.md +++ b/docs/SECURITY-ADVISORY.md @@ -1,3 +1,9 @@ + + # Anatomy of a curl security advisory As described in the [Security Process](https://curl.se/dev/secprocess.html) diff --git a/docs/SPONSORS.md b/docs/SPONSORS.md index bec96809c4..bb11097604 100644 --- a/docs/SPONSORS.md +++ b/docs/SPONSORS.md @@ -1,3 +1,9 @@ + + # curl sponsors A sponsor is someone who donates money or resources to the curl project for no diff --git a/docs/SSL-PROBLEMS.md b/docs/SSL-PROBLEMS.md index 86262222fa..26deed3911 100644 --- a/docs/SSL-PROBLEMS.md +++ b/docs/SSL-PROBLEMS.md @@ -1,8 +1,8 @@ - _ _ ____ _ - ___| | | | _ \| | - / __| | | | |_) | | - | (__| |_| | _ <| |___ - \___|\___/|_| \_\_____| + # SSL problems diff --git a/docs/SSLCERTS.md b/docs/SSLCERTS.md index caac51c42f..5edd5c4776 100644 --- a/docs/SSLCERTS.md +++ b/docs/SSLCERTS.md @@ -1,3 +1,9 @@ + + SSL Certificate Verification ============================ diff --git a/docs/TheArtOfHttpScripting.md b/docs/TheArtOfHttpScripting.md index 4e111a3e3d..5bb15a457d 100644 --- a/docs/TheArtOfHttpScripting.md +++ b/docs/TheArtOfHttpScripting.md @@ -1,3 +1,9 @@ + + # The Art Of Scripting HTTP Requests Using Curl ## Background diff --git a/docs/URL-SYNTAX.md b/docs/URL-SYNTAX.md index 67f9bdbc64..52e0ece153 100644 --- a/docs/URL-SYNTAX.md +++ b/docs/URL-SYNTAX.md @@ -1,3 +1,9 @@ + + # URL syntax and their use in curl ## Specifications diff --git a/docs/VERSIONS.md b/docs/VERSIONS.md index fc21749ee0..a3159aa6c4 100644 --- a/docs/VERSIONS.md +++ b/docs/VERSIONS.md @@ -1,3 +1,9 @@ + + Version Numbers and Releases ============================ diff --git a/docs/VULN-DISCLOSURE-POLICY.md b/docs/VULN-DISCLOSURE-POLICY.md index f18db6d52f..0f89816e01 100644 --- a/docs/VULN-DISCLOSURE-POLICY.md +++ b/docs/VULN-DISCLOSURE-POLICY.md @@ -1,3 +1,9 @@ + + # curl vulnerability disclosure policy This document describes how security vulnerabilities are handled in the curl diff --git a/scripts/copyright.pl b/scripts/copyright.pl index c83b7ebbde..376f023e77 100755 --- a/scripts/copyright.pl +++ b/scripts/copyright.pl @@ -135,7 +135,13 @@ sub dep5 { while() { $line++; if(/^Files: (.*)/i) { - push @files, `git ls-files $1`; + my @all = `git ls-files $1`; + if(!$all[0]) { + print STDERR "$1 matches no files\n"; + } + else { + push @files, @all; + } } elsif(/^Copyright: (.*)/i) { $copy = $1;