Merge branch 'develop' into test-pyahocorasick

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

CHANGELOG.rst

@@ -70,7 +70,7 @@ These are the details for the most important changes introduced::
       license attributes
     - `gen-new-required-phrases-rules` to add required phrase rules for
       marked required phrase in rules
-  This improves detection accuracy and reduces false positives. 
+  This improves detection accuracy and reduces false positives.
   https://github.com/aboutcode-org/scancode-toolkit/pull/3924
   https://github.com/aboutcode-org/scancode-toolkit/pull/4237
   https://github.com/aboutcode-org/scancode-toolkit/pull/4241

docs/source/cli-reference/help-text-options.rst

@@ -13,7 +13,7 @@ can't access, the more elaborate online documentation.
 Help text
 ---------
 
-The Scancode-Toolkit Command Line Interface has a Help option displaying all the options. It also
+The ScanCode-Toolkit Command Line Interface has a Help option displaying all the options. It also
 displays basic usage, and some simple examples. The command line option for this is ``--help``.
 
 .. Tip::
@@ -24,7 +24,7 @@ To see the help text from the Terminal, execute the following command::
 
     $ scancode --help
 
-The Following Help Text is displayed, i.e. This is the help text for Scancode Version 32.0.0:
+The Following Help Text is displayed, i.e. This is the help text for ScanCode Version 32.0.0:
 
 .. code-block:: none
 
@@ -165,7 +165,7 @@ The Following Help Text is displayed, i.e. This is the help text for Scancode Ve
                               seconds. [default: 120 seconds]
       -n, --processes INT     Set the number of parallel processes to use. Disable
                               parallel processing if 0. Also disable threading if
-                              -1. [default: 1]
+                              -1. [default: (number of CPUs)-1]
       -q, --quiet             Do not print summary or progress.
       -v, --verbose           Print progress as file-by-file path instead of a
                               progress bar. Print verbose scan counters.
@@ -212,7 +212,7 @@ The Following Help Text is displayed, i.e. This is the help text for Scancode Ve
 Command Examples Text
 ---------------------
 
-The Scancode-Toolkit Command Line Interface has an ``--examples`` option which displays some basic
+The ScanCode-Toolkit Command Line Interface has an ``--examples`` option which displays some basic
 examples (more than the basic synopsis in ``--help``). These examples include the following aspects
 of code scanning:
 
@@ -229,9 +229,9 @@ To see the help text from the Terminal, execute the following command::
 
     $ scancode --examples
 
-The Following Text is displayed, i.e. This is the examples for Scancode Version 3.1.1 ::
+The Following Text is displayed, i.e. This is the examples for ScanCode Version 3.1.1 ::
 
-    Scancode command lines examples:
+    ScanCode command lines examples:
 
     (Note for Windows: use '\' back slash instead of '/' forward slash for paths.)
 
@@ -311,7 +311,7 @@ To see the help text from the Terminal, execute the following command::
     #. Output Control
     #. Basic Scan Options
 
-The Following Text is displayed, i.e. This is the available plugins for Scancode Version 31.2.1 ::
+The Following Text is displayed, i.e. This is the available plugins for ScanCode Version 31.2.1 ::
 
   --------------------------------------------
   Plugin: scancode_output:csv  class: formattedcode.output_csv:CsvOutput
@@ -825,7 +825,7 @@ The Following Text is displayed, i.e. This is the available plugins for Scancode
 ``--list-packages`` Option
 --------------------------
 
-This shows all the types of packages that can be scanned using Scancode.
+This shows all the types of packages that can be scanned using ScanCode.
 These are located in packagedcode i.e. Code used to parse various package formats.
 
 See the :ref:`supported_packages` page for more details and documentation

docs/source/cli-reference/list-options.rst

@@ -3,7 +3,7 @@
 All Available Options
 =====================
 
-This section contains an exhaustive list of all Scancode options, arranged in various sections.
+This section contains an exhaustive list of all ScanCode options, arranged in various sections.
 The sections are as follows:
 
 - Basic Scan Options

docs/source/cli-reference/other-commands.rst

@@ -16,7 +16,7 @@ Other available CLIs
 ``scancode-reindex-licenses`` command
 -------------------------------------
 
-ScanCode maintains a license index to search for and detect licenses. When Scancode is
+ScanCode maintains a license index to search for and detect licenses. When ScanCode is
 configured for the first time, a license index is built and used in every scan thereafter.
 
 This ``scancode-reindex-licenses`` command rebuilds the license index. Running this command
@@ -33,7 +33,7 @@ The ``--additional-directory`` option allows the user to include additional dire
 of licenses to use in license detection.
 
 This command only needs to be run once for each set of additional directories, in all subsequent
-runs of Scancode with the same directories all the licenses in the directories will be cached
+runs of ScanCode with the same directories all the licenses in the directories will be cached
 and used in License detection. But reindexing removes these directories, if they aren't
 reintroduced as additional directories.
 

docs/source/cli-reference/output-filters-and-control.rst

@@ -1,6 +1,6 @@
 .. _cli_output_control_filters:
 
-Controlling Scancode Output and Filters
+Controlling ScanCode Output and Filters
 =======================================
 
 .. include::  /rst_snippets/output_control_options.rst

docs/source/cli-reference/output-format.rst

@@ -1,9 +1,9 @@
 .. _cli_output_format:
 
-Scancode Output Formats
+ScanCode Output Formats
 =======================
 
-Scan results generated by Scancode are available in different formats, to be specified by the
+Scan results generated by ScanCode are available in different formats, to be specified by the
 following options.
 
 .. include::  /rst_snippets/output_format_options.rst
@@ -22,7 +22,7 @@ following options.
 ---------------
 
     Among the ScanCode Output Formats, ``json`` is the most important one, and is recommended over
-    others. Scancode Workbench and other applications that use Scancode Result data as input accept
+    others. ScanCode Workbench and other applications that use ScanCode Result data as input accept
     only the ``json`` format.
 
     The following code performs a scan on the samples directory, and publishes the results in
@@ -199,7 +199,7 @@ following options.
           "scan_errors": []
         },
 
-    This is the recommended Output option for Scancode Toolkit.
+    This is the recommended Output option for ScanCode Toolkit.
 
 ----
 
@@ -548,7 +548,7 @@ Comparing Different ``json`` Output Formats
 
 ``--cyclonedx FILE``
 --------------------
-    Scancode also supports the `CycloneDx <https://cyclonedx.org/specification/overview/>`_ output format
+    ScanCode also supports the `CycloneDx <https://cyclonedx.org/specification/overview/>`_ output format
 
     Please note that this output format is only useful when scanning with the ``--package`` option
 

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

@@ -18,7 +18,7 @@ Pre-Scan Options
 
         scancode --ignore "*.java" samples samples.json
 
-    Here, Scancode ignores files ending with `.java`, and continues with other files as usual.
+    Here, ScanCode ignores files ending with `.java`, and continues with other files as usual.
 
     More information on :ref:`glob_pattern_matching`.
 
@@ -35,7 +35,7 @@ Pre-Scan Options
 
         scancode --include "*.java" samples samples.json
 
-    Here, Scancode selectively scans files that has names ending with `.java`, and ignores all other files. This
+    Here, ScanCode selectively scans files that has names ending with `.java`, and ignores all other files. This
     is basically complementary in behavior to the ``--ignore`` option.
 
     More information on :ref:`glob_pattern_matching`.

docs/source/cli-reference/synopsis.rst

@@ -27,6 +27,7 @@ detailed Instructions on the each of the Installation Methods.
 - :ref:`pip_install`
 - :ref:`source_code_install`
 
+
 .. _synopsis_quickstart:
 
 Quickstart
@@ -37,11 +38,11 @@ The basic command to perform a scan, in case of a download and configure install
 
     path/to/scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
 
-The basic usage, if Scancode is installed from ``pip``, or in Windows::
+The basic usage, if ScanCode is installed from ``pip``, or in Windows::
 
     scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
 
-Here Scancode scans the <SCAN INPUT> file or directory for license, origin and packages and saves
+Here ScanCode scans the <SCAN INPUT> file or directory for license, origin and packages and saves
 results to FILE(s) using one or more output format option. Error and progress are printed to
 stdout.
 
@@ -66,10 +67,10 @@ While a scan using absolute paths from the file system root will look like::
 Commands similar to ``scancode -clpi --json-pp output.json samples`` will be used as examples
 throughout the documentation.
 
-- Here we are inside the ``virtualenv`` where Scancode-Toolkit is configured.
+- Here we are inside the ``virtualenv`` where ScanCode-Toolkit is configured.
 
 - And the default ``samples`` folder is being scanned, which is distributed by default with
-  Scancode-Toolkit.
+  ScanCode-Toolkit.
 
 .. _scancode_cli_options:
 

docs/source/contribute/gsoc19_final_report.rst

@@ -13,7 +13,7 @@ Overview
 
 **Problem:** Since Python 2.7 will retire in few months and will not be maintained any longer.
 
-**Solution:** `Scancode <https://github.com/aboutcode-org/scancode-toolkit/>`__ needs to be ported to
+**Solution:** `ScanCode <https://github.com/aboutcode-org/scancode-toolkit/>`__ needs to be ported to
 python 3 and all test suites must pass on both version of Python. The main difference that
 makes Python 3 better than Python 2.x is that the support for unicode is greatly improved in
 Python 3. This will also be useful for scancode as scancode has users in more than 100 languages
@@ -79,7 +79,7 @@ We choose the third solution because it is most fundamental and simple and easy
 
 Project was tracked in this ticket `nexB/scancode-toolkit#295 <https://github.com/aboutcode-org/scancode-toolkit/issues/295>`__
 
-**Project link :** `Port Scancode to Python 3 <https://summerofcode.withgoogle.com/organizations/6118953540124672/>`__
+**Project link :** `Port ScanCode to Python 3 <https://summerofcode.withgoogle.com/organizations/6118953540124672/>`__
 
 ..
     [Org Link] https://summerofcode.withgoogle.com/organizations/6118953540124672/

docs/source/contribute/gsoc21_final_report.rst

@@ -10,10 +10,10 @@ Akanksha Garg <akanksha.garg2k@gmail.com>
 `GITHUB <https://github.com/akugarg>`_
 
 
-Project: Detect Unknown Licenses and Indirect License References in Scancode
------------------------------------------------------------------------------
+Project: Detect Unknown Licenses and Indirect License References in ScanCode
+----------------------------------------------------------------------------
 
-`ScanCode-toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_
+`ScanCode-Toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_
 
 `Project Link <https://summerofcode.withgoogle.com/archive/2021/projects/6229596998991872>`_
 
@@ -24,7 +24,7 @@ Description
 ------------
 
 The main motive of this project was to improve license detection of unknown licenses
-and follow references to indirect license references in Scancode-TK
+and follow references to indirect license references in ScanCode-Toolkit
 
 **Improvement in the License Data Model Definition**
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -78,7 +78,7 @@ containing n-grams from all regular license texts and rules. This is tracked in
 **Addition of some new Licenses**
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-There were some licenses that were not present in Scancode-toolkit as for now.
+There were some licenses that were not present in ScanCode-Toolkit as for now.
 They have been added now.
 
 `nexB/scancode-toolkit#2625 <https://github.com/aboutcode-org/scancode-toolkit/pull/2625>`_

docs/source/getting-started/install.rst

@@ -19,7 +19,7 @@ For advanced usage and experienced users, you can also use any of these mode:
 
 - :ref:`docker_install`
 
-    An alternative to installing the latest Scancode Toolkit release natively is
+    An alternative to installing the latest ScanCode-Toolkit release natively is
     to build a Docker image from the included Dockerfile. The only prerequisite
     is a working Docker installation.
 
@@ -80,7 +80,7 @@ ScanCode needs a Python 3.9+ interpreter; We support all Python versions from
 
     For Ubuntu, it is ``sudo apt install python3-dev``
 
-    - On Ubuntu 16, 18, 20 and 22 run::
+    - On Ubuntu 16, 18, 20 ,22 and 24 run::
 
           sudo apt install python-dev bzip2 xz-utils zlib1g libxml2-dev libxslt1-dev libpopt0
 
@@ -114,7 +114,7 @@ ScanCode needs a Python 3.9+ interpreter; We support all Python versions from
     .. Note::
 
       64-bit Python interpreters (x86-64) are the only interpreters supported by
-      Scancode on all operating systems which means only 64-bit Windows is supported.
+      ScanCode on all operating systems which means only 64-bit Windows is supported.
 
     See the :ref:`windows_app_install` section for more installation details.
 
@@ -125,7 +125,7 @@ ScanCode needs a Python 3.9+ interpreter; We support all Python versions from
 Installation as an Application: Downloading Releases
 -----------------------------------------------------
 
-Get the Scancode Toolkit tarball archive of a specific version and your
+Get the ScanCode Toolkit tarball archive of a specific version and your
 operating system by going to the `project releases page <https://github.com/aboutcode-org/scancode-toolkit/releases/>`_
 
 For example, Version 30.0.1 archive can be obtained from
@@ -194,8 +194,8 @@ This will configure ScanCode and display the command line :ref:`cli_help_text`.
 
 .. _windows_app_install:
 
-Installation on Windows 10
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+Installation on Windows 10/11
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 - Download the latest ScanCode release zip file for Windows from the latest
   version at https://github.com/aboutcode-org/scancode-toolkit/releases/
@@ -234,7 +234,7 @@ Installation on Windows 10
   then Right-click in this window and select Paste. This will paste the path you
   copied before and is where you extracted ScanCode::
 
-    cd path/to/extracted/ScanCode
+    cd path\to\extracted\ScanCode
 
 - Press Enter.
 
@@ -267,7 +267,7 @@ Un-installation
 Installation via Docker:
 ------------------------
 
-You can install Scancode Toolkit by building a Docker image from the included Dockerfile.
+You can install ScanCode Toolkit by building a Docker image from the included Dockerfile.
 The prerequisite is a working `docker installation <https://docs.docker.com/engine/install/>`_.
 
 
@@ -317,7 +317,7 @@ those after will be forwarded to scancode.
 Installation from Source Code: Git Clone
 -----------------------------------------
 
-You can download the Scancode Toolkit Source Code and build from it yourself.
+You can download the ScanCode Toolkit Source Code and build from it yourself.
 This is what you would want to do it if:
 
 - You are developing ScanCode or adding new patches or want to run tests.