Update "ScanCode Toolkit" to "ScanCode-Toolkit"

chinyeungli · chinyeungli · commit a0576b52e072 · 2025-06-26T13:41:35.000+08:00
Signed-off-by: Chin Yeung Li &lt;tli@nexb.com&gt;
diff --git a/docs/source/cli-reference/output-format.rst b/docs/source/cli-reference/output-format.rst
@@ -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.
 
 ----
 
diff --git a/docs/source/cli-reference/scan-options-post.rst b/docs/source/cli-reference/scan-options-post.rst
@@ -53,7 +53,7 @@ To see all plugins available via command line help, use ``--plugins``.
     .. note::
 
         The ``--consolidate`` option will be deprecated in a future version of
-        ScanCode Toolkit as top level packages, dependencies and licenses
+        ScanCode-Toolkit as top level packages, dependencies and licenses
         now provide improved consolidated data.
 
     The JSON file containing scan results after using the ``--consolidate`` Plugin is structured as
diff --git a/docs/source/cli-reference/synopsis.rst b/docs/source/cli-reference/synopsis.rst
@@ -62,7 +62,7 @@ throughout the documentation.
 Type of Options
 ---------------
 
-ScanCode Toolkit Command Line options can be divided into these major sections:
+ScanCode-Toolkit Command Line options can be divided into these major sections:
 
 - :ref:`cli_basic`
 - :ref:`Extractcode Options <cli_extract>`
diff --git a/docs/source/getting-started/home.rst b/docs/source/getting-started/home.rst
@@ -41,7 +41,7 @@ most advanced open source and commercial tools available today for Software
 Composition Analysis.
 
 
-What does ScanCode Toolkit do?
+What does ScanCode-Toolkit do?
 ------------------------------
 
 ScanCode detects and normalizes origin, dependencies, licensing and other
diff --git a/docs/source/getting-started/install.rst b/docs/source/getting-started/install.rst
@@ -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
@@ -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/>`_.
 
 
@@ -318,7 +318,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.
diff --git a/docs/source/getting-started/newcomer.rst b/docs/source/getting-started/newcomer.rst
@@ -38,10 +38,10 @@ Table of Contents
 
 .. _newcomer_try_scancode:
 
-Try ScanCode Toolkit
+Try ScanCode-Toolkit
 --------------------
 
-This section is about using the ScanCode Toolkit, i.e. Performing a scan on a codebase/files to
+This section is about using the ScanCode-Toolkit, i.e. Performing a scan on a codebase/files to
 determine their license, copyrights and other information, according to your requirements.
 
 #. The :ref:`newcomer_scan_codebase` section helps you with configuring your virtual environment,
@@ -142,7 +142,7 @@ ScanCode Versions
 
 .. _newcomer_learn_scancode:
 
-Learn more about ScanCode Toolkit
+Learn more about ScanCode-Toolkit
 ---------------------------------
 
 Here we give an introduction on the ScanCode-Toolkit Documentation Sections that can help you to
@@ -153,7 +153,7 @@ learn more about ScanCode-Toolkit.
 CLI Reference
 ^^^^^^^^^^^^^
 
-This section contains a complete guide to ScanCode Toolkit Command Line options, i.e. What the
+This section contains a complete guide to ScanCode-Toolkit Command Line options, i.e. What the
 command-line options are, how different options affect the scan and outputs, how to use these
 options and examples of their use cases.
 
@@ -179,7 +179,7 @@ This section has documentation on :ref:`explain_how_scancode_works`.
 Plugins
 ^^^^^^^
 
-Plugins are an integral part of ScanCode Toolkit in the sense they are used to easily extend
+Plugins are an integral part of ScanCode-Toolkit in the sense they are used to easily extend
 ScanCode capabilities, and developers can code their own plugins according to their requirements.
 
 This section has documentation on:
@@ -215,7 +215,7 @@ If you haven't contributed to ScanCode-Toolkit refer :ref:`newcomer_good_first_i
 
 To determine where to contribute, you can refer:
 
-#. ScanCode Toolkit tracks issues via the `GitHub Issue tracker <https://github.com/aboutcode-org/scancode-toolkit/issues>`_
+#. ScanCode-Toolkit tracks issues via the `GitHub Issue tracker <https://github.com/aboutcode-org/scancode-toolkit/issues>`_
 #. Broad `milestones <https://github.com/aboutcode-org/scancode-toolkit/milestones>`_ for upcoming versions are also maintained.
 
 And documentation related to contributing code can be referred at :ref:`contrib_code_dev`.
@@ -266,7 +266,7 @@ You can contribute to the following Open Issues on documentation.
 
 #. `First Timers Only Issues List <https://github.com/aboutcode-org/scancode-toolkit/issues/1826>`_
 #. `Documentation Inconsistencies Tracker <https://github.com/aboutcode-org/scancode-toolkit/issues/1813>`_
-#. `ScanCode Toolkit Documentation Roadmap <https://github.com/aboutcode-org/scancode-toolkit/issues/1824>`_
+#. `ScanCode-Toolkit Documentation Roadmap <https://github.com/aboutcode-org/scancode-toolkit/issues/1824>`_
 #. `Issues with label Documentation <https://github.com/aboutcode-org/scancode-toolkit/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation>`_
 
 .. note::
diff --git a/docs/source/how-to-guides/install_new_license_plugin.rst b/docs/source/how-to-guides/install_new_license_plugin.rst
@@ -40,7 +40,7 @@ Entry points definition in ``setup.py``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 First, in ``setup.py``, you must provide an entry point called ``scancode_location_provider``.
-This allows ScanCode Toolkit to discover the plugin and use it in license detection.
+This allows ScanCode-Toolkit to discover the plugin and use it in license detection.
 Here is the definition of ``entry_points`` in ``setup.py``::
 
     entry_points={
@@ -51,7 +51,7 @@ Here is the definition of ``entry_points`` in ``setup.py``::
 
 The ``scancode_location_provider`` entry point maps to a list with information about the plugin.
 The variable ``licenses_to_install1`` is the name of the entry point. All entry point names
-**must** start with the prefix ``licenses``, or else ScanCode Toolkit will not use them in
+**must** start with the prefix ``licenses``, or else ScanCode-Toolkit will not use them in
 license detection.
 
 Directory structure
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,9 +1,9 @@
-ScanCode Toolkit Documentation
+ScanCode-Toolkit Documentation
 ==============================
 
-Welcome to ScanCode Toolkit Documentation!
+Welcome to ScanCode-Toolkit Documentation!
 
-If you are new to ScanCode Toolkit, start here:
+If you are new to ScanCode-Toolkit, start here:
 
 .. toctree::
    :maxdepth: 2
@@ -100,7 +100,7 @@ Reference Documents
 --------------------
 
 Reference documents provide reference pages for technical reference information
-about ScanCode Toolkit, including how it works and supported features.
+about ScanCode-Toolkit, including how it works and supported features.
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/misc/support.rst b/docs/source/misc/support.rst
@@ -24,5 +24,5 @@ Join the conversation
 
 Join our `general chatroom <https://matrix.to/#/#aboutcode-org_discuss:gitter.im>`_ to chat
 with aboutcode community members, and if you want to talk to users and developers of
-ScanCode Toolkit, use `scancode room <https://matrix.to/#/#aboutcode-org_scancode:gitter.im>`_
+ScanCode-Toolkit, use `scancode room <https://matrix.to/#/#aboutcode-org_scancode:gitter.im>`_
 
diff --git a/docs/source/tutorials/how_to_extract_archives.rst b/docs/source/tutorials/how_to_extract_archives.rst
@@ -3,7 +3,7 @@
 How To Extract Archives
 =======================
 
-ScanCode Toolkit provides archive extraction. This command can be used before running a scan over
+ScanCode-Toolkit provides archive extraction. This command can be used before running a scan over
 a codebase in order to ensure all archives are extracted. Archives found inside an extracted
 archive are extracted recursively. Extraction is done in-place in a directory and named after the
 archive with ``'-extract'`` appended.
diff --git a/docs/source/tutorials/how_to_set_what_will_be_detected_in_a_scan.rst b/docs/source/tutorials/how_to_set_what_will_be_detected_in_a_scan.rst
@@ -5,7 +5,7 @@ How to set what will be detected in Scan
 
 ScanCode allows you to scan a codebase for license, copyright and other interesting information
 that can be discovered in files. The following options are available for detection when using
-ScanCode Toolkit:
+ScanCode-Toolkit:
 
 .. include::  /rst_snippets/basic_options.rst
 
diff --git a/docs/source/tutorials/how_to_visualize_scan_results.rst b/docs/source/tutorials/how_to_visualize_scan_results.rst
@@ -9,7 +9,7 @@ Detailed Installation and Usage guide can be found here -  :ref:`scancode-workbe
 
 .. WARNING::
 
-    This tutorial uses the 32.x version of ScanCode-Toolkit, and ScanCode Workbench 4.0.x (This version of ScanCode Workbench is compatible with scans from any ScanCode Toolkit develop
+    This tutorial uses the 32.x version of ScanCode-Toolkit, and ScanCode Workbench 4.0.x (This version of ScanCode Workbench is compatible with scans from any ScanCode-Toolkit develop
     version/branch at or after v32.x). If you are using an older version of ScanCode-Toolkit, check
     respective versions of this documentation. Also refer the ScanCode Workbench
     `release highlights <https://github.com/aboutcode-org/scancode-workbench/releases/>`_.
