search

LumoSQL / archive1-LumoSQL-on-github

Initial work on SQLite and LMDB integration
https://lumosql.github.io/LumoSQL/
Other
68 stars 14 forks source link

Add to SPDX metadata in source and documentation files #45

Closed danshearer closed 4 years ago

danshearer commented 4 years ago

At present source files have two SPDX lines eg:

/* 
SPDX-License-Identifier: Apache-2.0
SPDX-FileCopyrightText: 2019 The LumoSQL Authors
*/

And documentation files have three SPDX lines:

<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
<!-- SPDX-FileCopyrightText: 2020 The LumoSQL Authors -->
<!-- SPDX-FileType: Documentation -->

For the benefit of search engines we should add to all files:

<!-- SPDX-ArtifactOfProjectName: LumoSQL -->

As distinct from the Copyright tag ("2019 The LumoSQL Authors") there are good reasons to identify the original author of every file. Git tracks all the authors, but the original is special, so we should add this as a form a meta-meta data:

<!-- SPDX-FileComment: Original by Yasmin McGootchie, 2020 -->

For source code, not documentation, we should also add SPDX-FileName, for example:

SPDX-FileName: lmdb-backend/src/btree.c

The reason for not using SPDX-FileName for documentation is that it needs to be possible to trivially rename a doc file without having to remember to update the metadata.

danshearer commented 4 years ago

Done