Skip to content

Updated/Corrected KEY file's description #2506 #4470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/source/cli-reference/scan-options-pre.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
Loading