Browse Source

Merge branch 'master' into root-dir

root-dir
carmenbianca 3 weeks ago
parent
commit
f18c8de4f7
Signed by: Carmen Bianca Bakker <carmenbianca@fsfe.org> GPG Key ID: 76EBA6F6B6EA2EC9
7 changed files with 42 additions and 31 deletions
  1. 1
    1
      .bumpversion.cfg
  2. 3
    1
      CHANGELOG.md
  3. 1
    1
      docs/conf.py
  4. 33
    26
      docs/usage.rst
  5. 1
    1
      setup.py
  6. 1
    1
      src/reuse/__init__.py
  7. 2
    0
      src/reuse/_comment.py

+ 1
- 1
.bumpversion.cfg View File

@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.5.2
current_version = 0.6.0
commit = True
tag = False
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?P<release>(a|b|rc)?)(?P<releasenumber>\d*)

+ 3
- 1
CHANGELOG.md View File

@@ -19,7 +19,7 @@ following sections:

The versions follow [semantic versioning](https://semver.org).

## Unreleased - YYYY-MM-DD
## 0.6.0 - 2019-11-19

### Added

@@ -30,6 +30,8 @@ The versions follow [semantic versioning](https://semver.org).

+ .kt
+ .xml
+ .yaml
+ .yml

- Implemented `--root` argument to specify the root of the project without
heuristics.

+ 1
- 1
docs/conf.py View File

@@ -71,7 +71,7 @@ author = "Free Software Foundation Europe"
# built documents.
#
# The short X.Y version.
version = "0.5.2"
version = "0.6.0"
# The full version, including alpha/beta/rc tags.
release = version


+ 33
- 26
docs/usage.rst View File

@@ -9,6 +9,33 @@ obvious when using the tool. This chapter does not cover *everything*, assuming
that the user is helped enough by ``reuse --help`` and ``reuse <subcommand>
--help``.

Implementation details
======================

This section covers implementation details that are true for the entire tool.

When searching for copyright and licensing tags inside of files, the tool does
not strictly limit itself to the header comment as prescribed by the
specification. It searches the first 4 kibibytes of the file. This makes sure
that the tool can parse any type of plain-text file, even if the comment style
is not recognised.

If a file is found to have an unparseable tag, that file is not parsed at all.
This is `a bug <https://github.com/fsfe/reuse-tool/issues/4>`_.

The tool does not verify the correctness of copyright notices. If it finds any
line containing '©', 'Copyright', or 'SPDX-FileCopyrightText:', then the tag and
everything following it is considered a valid copyright notice, even if the
copyright notice is not compliant with the specification.

When running the tool, the root of the project is automatically found if the
working directory is inside a git repository. Otherwise, it treats the working
directory as the root of the project. You can override the root of the project
with the ``--root`` optional argument.

Git submodules are automatically ignored unless ``--include-submodules`` is
passed as optional argument.

addheader
=========

@@ -174,34 +201,14 @@ This is some example output of ``reuse lint``:

Unfortunately, your project is not compliant with version 3.0 of the REUSE Specification :-(

Implementation details
----------------------

The following implementation details might be relevant for your use of the tool.

The linter does not strictly limit itself to the header comment as prescribed by
the specification. It searches the first 4 kibibytes of the file for copyright
and licensing information. This makes sure that the linter can parse any type of
plain-text file, even if the comment style is not recognised.

If a file is found to have an unparseable tag, that file is not parsed at all.
This is `a bug <https://github.com/fsfe/reuse-tool/issues/4>`_.

The tool does not verify the correctness of copyright notices. If it finds any
line containing '©', 'Copyright', or 'SPDX-FileCopyrightText:', then the tag and
everything following it is considered a valid copyright notice, even if the
copyright notice is not compliant with the specification.
..
Implementation details
----------------------

When running ``reuse``, the root of the project is automatically found if the
working directory is inside a git repository. Otherwise, it treats the working
directory or the specified directory as the root of the project. You can
override the root of the project with the ``--root`` optional argument.

Git submodules are automatically ignored unless ``--include-submodules`` is
passed as optional argument.
The following implementation details might be relevant for your use of the linter.

The STDOUT output of ``reuse lint`` is valid Markdown. Occasionally some logging
will be printed to STDERR, which is not valid Markdown.
The STDOUT output of ``reuse lint`` is valid Markdown. Occasionally some logging
will be printed to STDERR, which is not valid Markdown.

Criteria
--------

+ 1
- 1
setup.py View File

@@ -109,7 +109,7 @@ class Build(build_py):
if __name__ == "__main__":
setup(
name="fsfe-reuse",
version="0.5.2",
version="0.6.0",
url="https://reuse.software/",
project_urls={
"Documentation": "https://reuse.readthedocs.io/",

+ 1
- 1
src/reuse/__init__.py View File

@@ -47,7 +47,7 @@ else:
__author__ = "Carmen Bianca Bakker"
__email__ = "carmenbianca@fsfe.org"
__license__ = "GPL-3.0-or-later"
__version__ = "0.5.2"
__version__ = "0.6.0"
__REUSE_version__ = "3.0"



+ 2
- 0
src/reuse/_comment.py View File

@@ -367,6 +367,8 @@ COMMENT_STYLE_MAP = {
".tex": TexCommentStyle,
".vala": CCommentStyle,
".xml": HtmlCommentStyle,
".yaml": PythonCommentStyle,
".yml": PythonCommentStyle,
".zsh": PythonCommentStyle,
}


Loading…
Cancel
Save