Skip to content

Commit 6e43a4f

Browse files
Merge pull request #4470 from aboutcode-org/2506_correct-key-file-doc
Updated/Corrected KEY file's description #2506
2 parents 78c9b10 + 4f8cb2c commit 6e43a4f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/source/cli-reference/scan-options-pre.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,11 @@ Pre-Scan Options
6868

6969
- key-file
7070

71-
A KEY file is a generic file extension used by various programs when registering legal copies
72-
of the software. It may be saved in a plain text format, but generally contains some form of
73-
encrypted key string that authenticates the purchase and registers the software.
71+
A KEY file serves as a keystone element, containing essential
72+
information about a software package — such as its dependencies,
73+
versioning, licensing, and more. It often contains the
74+
``primary-license`` or the overall license of the package, among
75+
other package metadata which are general or ecosystem specific.
7476

7577
As in, to the JSON object of each file scanned, these extra attributes are added::
7678

0 commit comments

Comments
 (0)