fsfe / reuse-docs

REUSE recommendations, tutorials, FAQ and specification

Home Page:https://reuse.software

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

averms opened this issue · comments

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?

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