Re: First batch of SPDX annotated SRFIs examples
Maxim Cournoyer 09 Dec 2023 23:06 UTC
Hi Lassi,
Lassi Kortela <xxxxxx@lassi.io> writes:
> Thank you for taking the time to produce the diffs. These are very
> easy to read.
Glad to know!
> Comments:
>
> Licensing .gitignore is excessive. If REUSE requires licenses for
> trivial files, perhaps list all of those in a metadata file.
I tried to use .reuse/dep5 like the following, and 'reuse lint' is still
happy:
--8<---------------cut here---------------start------------->8---
Unstaged changes (2)
modified .gitignore
@@ -1,5 +1 @@
-# SPDX-FileCopyrightText: 2020 Arthur A. Gleckler <xxxxxx@speechcode.com>
-#
-# SPDX-License-Identifier: MIT
-
*~
\ No newline at end of file
modified .reuse/dep5
@@ -5,6 +5,6 @@ Source: https://github.com/scheme-requests-for-implementation/srfi-209
# Sample paragraph, commented out:
#
-# Files: src/*
-# Copyright: $YEAR $NAME <$CONTACT>
-# License: ...
+Files: .gitignore
+Copyright: 2015 Arthur A. Gleckler <xxxxxx@srfi.schemers.org>
+License: MIT
--8<---------------cut here---------------end--------------->8---
I think I prefer the SPDX comments inside the .gitgnore file though,
even if just for uniformity with the rest.
> Comments in .html files should probably go below the <html> tag. See
> e.g. https://stackoverflow.com/questions/941100/can-comments-appear-before-the-doctype-declaration
>
> In comments of the following form
>
> # SPDX-FileCopyrightText: 2015 Arthur A. Gleckler <xxxxxx@speechcode.com>
> #
> # SPDX-License-Identifier: MIT
>
> the blank line in the middle can be omitted to save space. And last I
> checked, "SPDX-FileCopyrightText:" could be replaced with "Copyright"
> for more natural looking notices. E.g.
>
> # Copyright 2015 Arthur A. Gleckler <xxxxxx@speechcode.com>
> # SPDX-License-Identifier: MIT
I left the reuse tool take care of producing these (using something like
"reuse annotate -lMIT -y2015 -c'Arthur A. Gleckler <xxxxxx@speechcode.com>' .gitignore")
When there are multiple copyright holders, they are grouped together as
in:
# SPDX-FileCopyrightText: 2015 Some One <email1>
# SPDX-FileCopyrightText: 2018 Another One <email2>
#
# SPDX-License-Identifier: MIT
I don't feel strongly about it; I prefer to stick to what the tool
produces as it makes my life easier.
> We keep a bunch of per-SRFI metadata as S-expressions in this file:
> https://raw.githubusercontent.com/scheme-requests-for-implementation/srfi-common/master/admin/srfi-data.scm
>
> The file is regularly updated. I think we should store licensing
> information in there, and a script would then generate the files
> required by REUSE into the SRFI's repos. Arthur already generates the
> README files, so it's not much work to generate extra stuff.
REUSE doesn't require much in terms of files; I've been adding
.reuse/dep5 as it seems useful to track the repository source and
contact details there, and it's produced by the tool 'reuse init'; the
rest is simply metadata kept as comments at the top of the files, that
can conveniently added by invoking 'reuse annotate' as shown above.
--
Thanks,
Maxim