Details
-
Type:
RFC
-
Status: Withdrawn
-
Resolution: Done
-
Component/s: DM
-
Labels:None
Description
Please allow the usage of shortened, two-line headers for licensing in source files. Such as:
// SPDX-License-Identifier: GPL-3.0-or-later
|
/* Copyright (C) 2023 Jim Beam <jbeam@lsst.org> on behalf of the LSST DM team */
|
GPL shall alow that.
Our current developer guide states the following about header files:
(https://developer.lsst.io/stack/license-and-copyright.html)
License preambles in source files¶
|
|
The GPL-3.0 license requires each source file to have a preamble comment containing a license statement. This is the generic license preamble:
|
|
This file is part of {{ cookiecutter.package_name }}.
|
|
Developed for the LSST Data Management System.
|
This product includes software developed by the LSST Project
|
(https://www.lsst.org).
|
See the COPYRIGHT file at the top-level directory of this distribution
|
for details of code ownership.
|
|
This program is free software: you can redistribute it and/or modify
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation, either version 3 of the License, or
|
(at your option) any later version.
|
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
|
You should have received a copy of the GNU General Public License
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
Replace {{ cookiecutter.package_name }} with the repository’s name (afw, for example).
|
GPL doesn't require one to include the full header. Proofs:
https://www.gnu.org/licenses/gpl-howto.en.html
This involves adding two elements to each source file of your program: a copyright notice (such as “Copyright 1999 Terry Jones”), and a statement of copying permission, saying that the program is distributed under the terms of the GNU General Public License (or the Lesser GPL, or the Affero GPL).
|
Linux kernel switched to SPDX.dev (https://spdx.dev/), see https://spdx.dev/ids/"
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/atm/eni.c?h=v6.2
// SPDX-License-Identifier: GPL-2.0-only
|
/* drivers/atm/eni.c - Efficient Networks ENI155P device driver */
|
|
/* Written 1995-2000 by Werner Almesberger, EPFL LRC/ICA */
|
It's very unlikely Linux kernel have licensing problems.
The boilerplate in every file is completely unnecessary. The copyright and license exist independent of the content. Various projects have different policies. There's nothing preventing Rubin/LSST from decided that we don't want the useless bloat.