Skip to content

Correct key file doc #2506

Description

@pombredanne

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions