search

fsfe / reuse-docs

REUSE recommendations, tutorials, FAQ and specification
https://reuse.software
19 stars 20 forks source link

Clarify if a blank line is required between copyright and license info in a comment header #88

Closed averms closed 2 years ago

averms commented 2 years ago

All the examples and reuse addheader use a format like this:

SPDX-FileCopyrightText: {$year_of_file_creation} {$name_of_copyright_holder} <{$contact}>

SPDX-License-Identifier: {$SPDX_license_name}

I don't like the blank line between the two so all my comment headers look like the following:

SPDX-FileCopyrightText: {$year_of_file_creation} {$name_of_copyright_holder} <{$contact}>
SPDX-License-Identifier: {$SPDX_license_name}

I can't see anything in the specification mandating that blank line and reuse lint seems to be fine with it too. Is what I'm doing okay?

mxmehl commented 2 years ago

You are right, there is not obligation to use a blank line. We just do that by default to optically separate copyright and license information.

You could use templates to customise the default behaviour: https://reuse.readthedocs.io/en/stable/usage.html#templates