search

aboutcode-org / scancode-toolkit

:mag: ScanCode detects licenses, copyrights, dependencies by "scanning code" ... to discover and inventory open source and third-party packages used in your code. Sponsored by NLnet project https://nlnet.nl/project/vulnerabilitydatabase, the Google Summer of Code, Azure credits, nexB and others generous sponsors!
https://github.com/aboutcode-org/scancode-toolkit/releases/
2.08k stars 537 forks source link

Correct key file doc #2506

Open pombredanne opened 3 years ago

pombredanne commented 3 years ago

Description

We have this https://github.com/nexB/scancode-toolkit/blob/ebb55c341bc6ba644d2be0e531ffbfc2948bca47/docs/source/cli-reference/scan-options-pre.rst#L75

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 is not a license key file. This is a key more as in "keystone", e.g. an important file for the documentation of a package. See https://github.com/nexB/scancode-toolkit/blob/ebb55c341bc6ba644d2be0e531ffbfc2948bca47/src/summarycode/classify.py#L74 :

True if this file is "top-level" file and either a legal, readme or manifest file.

We need to fix this description

Ripoohann commented 1 month ago

Hey I want to work on this issue can you please elaborate