From 13e4fa746b1a7fbb8adae6d6bcd5bb52cb1588de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20Ri=C3=9Fe?= Date: Thu, 22 Jun 2023 10:21:31 +0200 Subject: [PATCH] Document changes to the handling of symlinks --- docs/usage.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/usage.rst b/docs/usage.rst index e9c505822..31778cc4b 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -39,7 +39,18 @@ passed as optional argument. Meson subprojects are automatically ignored if ``meson.build`` exists in the project root. ``--include-meson-subprojects`` overrides this behaviour. -Symbolic links and files that are zero-sized are automatically ignored. +Files that are zero-sized are automatically ignored. + +Symbolic links are handled differently depending on the target of the link: + +#. a symlink pointing to a covered file is considered to be the same file as + the covered file and is therefore ignored. +#. a symlink pointing to a file that is not a covered file is itself considered + to be a covered file and is not skipped, unless the symlink is ignored by + other means. + +A "covered file" is the term used in the REUSE Specification to name a file +that needs copyright and licensing information. annotate ========