aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2026-01-12 20:26:01 +0700
committerShulhan <ms@kilabit.info>2026-01-12 21:23:09 +0700
commitbf35b0b8ab23f07c491e1c6b97c90b772942b7b7 (patch)
tree47ede156fea419bf58fec10723645405f033fa62 /README.md
parent1d6f8cfc60be1ada414ac1a9ce8eb6f61a527a0f (diff)
downloadspdxconv-bf35b0b8ab23f07c491e1c6b97c90b772942b7b7.tar.xz
all: remove prefix config from struct matchCopyright and matchLicense
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 179c043..36a30fe 100644
--- a/README.md
+++ b/README.md
@@ -74,7 +74,7 @@ max_line_match = 10
[match-file-comment]
pattern = "^.*\\.(adoc|asciidoc|c|cc|cpp|cs|dart|go|h|hh|hpp|java|js|jsx|jsonc|kt|kts|php|rs|sass|scss|swift|ts|tsx)$"
-comment_prefix = "//"
+prefix = "//"
[match-file-comment]
pattern = "^.*\\.(bash|csh|dockerfile|env|gitignore|hcl|ipynb|make|pl|pm|py|ps1|rb|sh|tf|yaml|yml|zsh)$"
@@ -147,11 +147,11 @@ The default values is 10.
### match-file-comment section
-The first thing that the program do is to detect which comment string to be
-used when inserting SPDX identifiers in the file.
+The first thing that the program do is to detect which comment prefix and
+suffix to be used when inserting SPDX identifiers in the file.
For each pattern in the "match-file-comment" section, the program will match
-it with file name to get the comment prefix and suffix to be used later.
+it with file name to get the comment `prefix` and `suffix`.
User can add their own "match-file-comment" section as they like or modify
the existing one.