Revert "Revert "Merge branch 'main' into stable""

This reverts commit 1b277a5.

Author: carmenbianca

CHANGELOG.md

@@ -1,5 +1,6 @@
 <!--
 SPDX-FileCopyrightText: 2019 Free Software Foundation Europe e.V.
+SPDX-FileCopyrightText: 2023 DB Systel GmbH
 
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
@@ -21,28 +22,56 @@ The versions follow [semantic versioning](https://semver.org).
 
 ## Unreleased - YYYY-MM-DD
 
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
 ### Added
 
-- Clarify which license text files are needed if a SPDX license expression
-  contains more than one license and/or exception. (#96)
+## 3.1 - 2023-06-21
+
+### Added
+
+- Definition for Commentable and Uncommentable Files. (#123, thanks @Jayman2000)
+
+- Introduce support of in-line snippet comments using
+  `SPDX-SnippetBegin`/`SPDX-SnippetEnd`. (#107)
+
+- Specify encoding of `.license` files to UTF-8. (#106, thanks @kirelagin for
+  the helpful background information)
+
+- Introduce `REUSE-IgnoreStart`/`REUSE-IgnoreEnd` to make the REUSE helper tool
+  not consider the enclosed content for detecting copyright and licensing
+  information. (#104)
 
 - Definition for Covered File and clarify for which file copyright and licensing
   information is required. (#85, thanks @Jayman2000)
 
+- Remove SPDX documents from list of Covered Files. (#103)
+
+- Remove symlinks and zero-byte files from list of Covered Files. (#101)
+
+- Remove submodules and Meson subprojects from list of Covered Files. (#99)
+
+- Clarify which license text files are needed if a SPDX license expression
+  contains more than one license and/or exception. (#96)
+
 - URLs to currently applicable SPDX specification. (#49)
 
+- Define current order or precedence. (#131)
+  
 ### Changed
 
-### Deprecated
+- Allow `.license` files for commentable files, but strongly recommend adding
+  copyright/licensing information in header. (#123, thanks @Jayman2000)
 
-### Removed
+- Bump referenced SPDX version to 2.3, and update links. (#103) (#107)
 
 ### Fixed
 
 - Minor typos and grammar mistakes. Thanks @jlovejoy and @Jayman2000!
 
-### Security
-
 
 ## 3.0 - 2019-08-07
 

faq.md

@@ -416,16 +416,56 @@ You can read more about this file format by Debian
 
 ## Can I license only a part of a file as being under a different license? {#partial-license}
 
-The short answer is that yes, you can, but no, there is no standard way for
-REUSE to recognize this. If you have a small segment of a file that is licensed
-differently, you should list that license under a separate
-`SPDX-License-Identifier` tag in the header.
+Yes, you can. You should add in-line snippet comments if a copyright and/or
+licensing info applies to only a certain part of a file.
 
-You can use your own comments to specify which segment is separately licensed.
-For instance: "The class Foo is copied from project Bar and licensed under MIT.
-All changes are licensed under GPL-3.0-or-later."
+Such an annotated snippet block must start with `SPDX-SnippetBegin` to mark its
+beginning and end with `SPDX-SnippetEnd` to mark the snippet's end.
 
-A possible way to circumvent the problem is to extract the segment from the
+Do note that SPDX snippet tags MUST start with `SPDX-Snippet`, meaning that the
+correct copyright notice in a snippet is `SPDX-SnippetCopyrightText`.
+
+Example:
+
+```
+# SPDX-SnippetBegin
+# SPDX-License-Identifier: MIT
+# SPDX-SnippetCopyrightText: 2023 Jane Doe <[email protected]>
+
+{$snippet_code_goes_here}
+
+# SPDX-SnippetEnd
+```
+
+Snippets may nest, and this is denoted by having
+`SPDX-SnippetBegin`/`SPDX-SnippetEnd` pairs within other pairs, in the same way
+that parentheses nest in mathematical expressions. In the case of nested
+snippets, the SPDX file tags are considered to apply to the inner-most snippet. Example:
+
+```
+# SPDX-SnippetBegin
+# SPDX-License-Identifier: MIT
+# SPDX-SnippetCopyrightText: 2023 Jane Doe <[email protected]>
+
+{$snippet_code_under_MIT}
+
+# SPDX-SnippetBegin
+# SPDX-License-Identifier: BSD-2-Clause
+# SPDX-SnippetCopyrightText: Copyright Example Company
+
+{$snippet_code_under_BSD-2-Clause}
+
+# SPDX-SnippetEnd
+
+{$more_snippet_code_under_MIT}
+
+# SPDX-SnippetEnd
+```
+
+It is also considered good practice to further specify the origin of the
+snippet, for instance by a comment like "The class Foo is copied from project Bar".
+
+A possible alternative to the problem is to extract the segment from the
 file, and to keep it in its own file.
 
 ## How do I properly declare multi-licensing? {#multi-licensing}

po/reuse-docs.cs.po

@@ -8,7 +8,7 @@ msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: [email protected]\n"
 "POT-Creation-Date: 2020-08-19 12:43+0200\n"
-"PO-Revision-Date: 2022-04-13 12:12+0000\n"
+"PO-Revision-Date: 2022-05-01 12:09+0000\n"
 "Last-Translator: Jiří Podhorecký <[email protected]>\n"
 "Language-Team: Czech <https://hosted.weblate.org/projects/fsfe/reuse-docs/cs/"
 ">\n"
@@ -17,7 +17,7 @@ msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=3; plural=(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2;\n"
-"X-Generator: Weblate 4.12-dev\n"
+"X-Generator: Weblate 4.12.1\n"
 
 #. type: YAML Front Matter: title
 #: faq.md
@@ -962,10 +962,10 @@ msgstr ""
 
 #. type: Plain text
 #: faq.md
-#, fuzzy, markdown-text
+#, markdown-text
 msgid "You should not edit license files. Please see [this question](#edit-license)."
 msgstr ""
-"Licenční soubory byste neměli upravovat. Viz [tato otázka](#edit-licence)."
+"Licenční soubory byste neměli upravovat. Viz [tato otázka](#edit-license)."
 
 #. type: Title ##
 #: faq.md
@@ -1023,7 +1023,7 @@ msgstr ""
 
 #. type: Plain text
 #: faq.md
-#, fuzzy, markdown-text, no-wrap
+#, markdown-text, no-wrap
 msgid ""
 "<!-- TODO: the linked section still needs to be written.\n"
 "Some licenses, such as MIT and the BSD family of licenses, have a line that says\n"
@@ -1033,8 +1033,7 @@ msgid ""
 msgstr ""
 "<!-- TODO: je třeba ještě napsat odkazovanou sekci. \n"
 "Některé licence, například MIT a rodina licencí BSD, obsahují řádek \n"
-"\"Copyright (c) [rok] [držitel autorských práv]\". O tom, jak s těmito "
-"licencemi \n"
+"\"Copyright (c) [year] [copyright holder]\". O tom, jak s těmito licencemi \n"
 "zacházet, se dočtete v [této otázce](#mit-bsd). \n"
 "-->\n"
 
@@ -1625,15 +1624,15 @@ msgstr ""
 
 #. type: Plain text
 #: tutorial.md
-#, fuzzy, markdown-text, no-wrap
+#, markdown-text, no-wrap
 msgid ""
 "The first thing you need to do is to [choose a license]({{< relref\n"
 "\"faq.md#which-license\" >}}). For this tutorial, we assume that you chose the GNU\n"
 "General Public License (GPL) v3.0 or any later version. More than simply\n"
 "choosing a license, you need to put the license in your project directory.\n"
 msgstr ""
 "Nejprve je třeba [vybrat licenci]({{< relref\n"
-"\"faq.md#which-licence\" >}}). Pro tento návod předpokládáme, že jste si "
+"\"faq.md#which-license\" >}}). Pro tento návod předpokládáme, že jste si "
 "vybrali licenci GNU\n"
 "General Public License (GPL) v3.0 nebo jakoukoli novější verzi. Nestačí než "
 "jen\n"