Skip to content

Commit

Permalink
Document changes to the handling of symlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
matrss committed Jun 22, 2023
1 parent 03f5b43 commit 13e4fa7
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
========
Expand Down

0 comments on commit 13e4fa7

Please sign in to comment.