From 4f8cb2cdde7f22493b6cdd8f3bed3d8e1f2ea307 Mon Sep 17 00:00:00 2001 From: Chin Yeung Li Date: Thu, 10 Jul 2025 11:48:21 +0800 Subject: [PATCH] Updated/Corrected KEY file's description #2506 Signed-off-by: Chin Yeung Li --- docs/source/cli-reference/scan-options-pre.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/source/cli-reference/scan-options-pre.rst b/docs/source/cli-reference/scan-options-pre.rst index d14107d25a..b1ccb54cf9 100644 --- a/docs/source/cli-reference/scan-options-pre.rst +++ b/docs/source/cli-reference/scan-options-pre.rst @@ -68,9 +68,11 @@ Pre-Scan Options - key-file - A KEY file is a generic file extension used by various programs when registering legal copies - of the software. It may be saved in a plain text format, but generally contains some form of - encrypted key string that authenticates the purchase and registers the software. + A KEY file serves as a keystone element, containing essential + information about a software package — such as its dependencies, + versioning, licensing, and more. It often contains the + ``primary-license`` or the overall license of the package, among + other package metadata which are general or ecosystem specific. As in, to the JSON object of each file scanned, these extra attributes are added::