aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2026-01-12 20:50:38 +0700
committerShulhan <ms@kilabit.info>2026-01-12 21:23:12 +0700
commit9817757f8dca159aa261315a91fceff1d9a13566 (patch)
treedd9ce0b3913e187b447c55518a01387fc059009d /README.md
parentbf35b0b8ab23f07c491e1c6b97c90b772942b7b7 (diff)
downloadspdxconv-9817757f8dca159aa261315a91fceff1d9a13566.tar.xz
all: add configuration for setting default copyright year
The `copyright_year` set the default year to be used in `SPDX-FileCopyrightText`. The year can be a single year (for example "2026"), range of year (for example, "2000-2026"), or list of year with comma separated (for example, "2000,2001,2026"); as long as there is no space in between.
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 21 insertions, 5 deletions
diff --git a/README.md b/README.md
index 36a30fe..5327e7e 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,7 @@ following content,
[default]
license_identifier =
+copyright_year =
file_copyright_text =
max_line_match = 10
@@ -134,11 +135,26 @@ affect the program during scan and apply.
### default section
-This section define the default license identifier and copyright text to be
-inserted into file if no `match-license` or `match-copyright` found in the
-file.
-You should fill the `license_identifier` and `file_copyright_text` before
-continue running the program.
+This section define the default license identifier, year, and copyright text
+to be inserted into file if no `match-license` or `match-copyright` found in
+the file.
+
+The `license_identifier` set the default license using one of SPDX license
+identifier from [https://spdx.org/licenses/]() .
+For example, `GPL-3.0-only` for GNU General Public License v3.0 only.
+
+The `copyright_year` set the default year to be used in
+`SPDX-FileCopyrightText`.
+The year can be a single year (for example "2026"), range of year (for
+example, "2000-2026"), or list of year with comma separated (for example,
+"2000,2001,2026"); as long as there is no space in between.
+
+The `file_copyright_text` set the default author and contact in
+`SPDX-FileCopyrightText`.
+For example, "John Doe <john.doe@example>".
+
+You should fill the `license_identifier`, `copyright_year`, and
+`file_copyright_text` before continue running the program.
The `max_line_match` define the number of lines to be searched at the
top and bottom of file for `SPDX-*` identifiers, `match-license`, and