diff --git a/docs/source/cli-reference/help-text-options.rst b/docs/source/cli-reference/help-text-options.rst index 5e7a7694601..8c813a8f048 100644 --- a/docs/source/cli-reference/help-text-options.rst +++ b/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 @@ -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 diff --git a/docs/source/cli-reference/list-options.rst b/docs/source/cli-reference/list-options.rst index 2d4a64deff2..8e2f14fa12f 100644 --- a/docs/source/cli-reference/list-options.rst +++ b/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 diff --git a/docs/source/cli-reference/other-commands.rst b/docs/source/cli-reference/other-commands.rst index 1fd0059a78f..53c56f01301 100644 --- a/docs/source/cli-reference/other-commands.rst +++ b/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. diff --git a/docs/source/cli-reference/output-filters-and-control.rst b/docs/source/cli-reference/output-filters-and-control.rst index 97ecc290a59..f78850d2e57 100644 --- a/docs/source/cli-reference/output-filters-and-control.rst +++ b/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 diff --git a/docs/source/cli-reference/output-format.rst b/docs/source/cli-reference/output-format.rst index 590cecd7fc4..753d45aa52c 100644 --- a/docs/source/cli-reference/output-format.rst +++ b/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 `_ output format + ScanCode also supports the `CycloneDx `_ output format Please note that this output format is only useful when scanning with the ``--package`` option diff --git a/docs/source/cli-reference/scan-options-pre.rst b/docs/source/cli-reference/scan-options-pre.rst index 3179f4ca98f..d14107d25ac 100644 --- a/docs/source/cli-reference/scan-options-pre.rst +++ b/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`. diff --git a/docs/source/cli-reference/synopsis.rst b/docs/source/cli-reference/synopsis.rst index d4405dd21a1..c3845f1095e 100644 --- a/docs/source/cli-reference/synopsis.rst +++ b/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] -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] -Here Scancode scans the file or directory for license, origin and packages and saves +Here ScanCode scans the 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: diff --git a/docs/source/contribute/contrib_doc.rst b/docs/source/contribute/contrib_doc.rst index 085c0d3c25e..e6c6b65a3e5 100644 --- a/docs/source/contribute/contrib_doc.rst +++ b/docs/source/contribute/contrib_doc.rst @@ -79,7 +79,7 @@ examples:: git push git status -The Scancode-Toolkit webhook with ReadTheDocs should rebuild the documentation after your +The ScanCode-Toolkit webhook with ReadTheDocs should rebuild the documentation after your Pull Request is Merged. Refer the `Pro Git Book `_ available online for Git tutorials diff --git a/docs/source/contribute/gsoc19_final_report.rst b/docs/source/contribute/gsoc19_final_report.rst index 5468258454f..67b8a589774 100644 --- a/docs/source/contribute/gsoc19_final_report.rst +++ b/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 `__ needs to be ported to +**Solution:** `ScanCode `__ 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 `__ -**Project link :** `Port Scancode to Python 3 `__ +**Project link :** `Port ScanCode to Python 3 `__ .. [Org Link] https://summerofcode.withgoogle.com/organizations/6118953540124672/ diff --git a/docs/source/contribute/gsoc21_final_report.rst b/docs/source/contribute/gsoc21_final_report.rst index c3836b27e5d..9b72e6d18ba 100644 --- a/docs/source/contribute/gsoc21_final_report.rst +++ b/docs/source/contribute/gsoc21_final_report.rst @@ -10,10 +10,10 @@ Akanksha Garg `GITHUB `_ -Project: Detect Unknown Licenses and Indirect License References in Scancode ------------------------------------------------------------------------------ +Project: Detect Unknown Licenses and Indirect License References in ScanCode +---------------------------------------------------------------------------- -`ScanCode-toolkit `_ +`ScanCode-Toolkit `_ `Project Link `_ @@ -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 `_ diff --git a/docs/source/getting-started/install.rst b/docs/source/getting-started/install.rst index 14620c77525..ed6ff448617 100644 --- a/docs/source/getting-started/install.rst +++ b/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 `_ 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 `_. @@ -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. diff --git a/docs/source/getting-started/newcomer.rst b/docs/source/getting-started/newcomer.rst index 8fcdf7aabb8..ffd1b9d70b9 100644 --- a/docs/source/getting-started/newcomer.rst +++ b/docs/source/getting-started/newcomer.rst @@ -1,6 +1,6 @@ .. _new_to_scancode: -Are you new to Scancode-Toolkit? +Are you new to ScanCode-Toolkit? ================================ This is the perfect place to start, if you are new to ScanCode-Toolkit. Have a quick look at the @@ -14,7 +14,6 @@ Table of Contents #. :ref:`newcomer_try_scancode` - :ref:`newcomer_before` - - :ref:`newcomer_install` - :ref:`newcomer_scan_codebase` - :ref:`newcomer_scancode_tips` - :ref:`newcomer_all_tutorials` @@ -46,7 +45,7 @@ This section is about using the ScanCode Toolkit, i.e. Performing a scan on a co determine their license, copyrights and other information, according to your requirements. #. The :ref:`newcomer_scan_codebase` section helps you with configuring your virtual environment, - installing Scancode and performing a basic scan, and subsequently visualize the results. + installing ScanCode and performing a basic scan, and subsequently visualize the results. #. The :ref:`newcomer_scancode_tips` section helps you customize the scan according to your requirements, and better understand the advanced features you can use. @@ -54,43 +53,21 @@ determine their license, copyrights and other information, according to your req #. The :ref:`newcomer_all_tutorials` is essentially an exhaustive list of all Tutorials and How To's with a brief description on what they help you to achieve. -.. _newcomer_install: - -Installing ScanCode -------------------- - -Scancode-Toolkit can be installed in 3 different methods. - -#. The :ref:`newcomer_scan_codebase` section helps you with configuring and - installing ScanCode and performing a basic scan, and then visualizing the - results. - -#. The :ref:`newcomer_scancode_tips` section helps you customize the scan - according to your requirements, and better understand advanced features. - -#. The :ref:`newcomer_all_tutorials` is an exhaustive directory of all Tutorials - and How To's with a brief description. - - .. _newcomer_before: Before you start using ScanCode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ #. You need to make sure :ref:`install_prerequisites` are installed, and a `virtualenv `_ - is created. - -:ref:`app_install` -:ref:`docker_install` -:ref:`pip_install` -:ref:`source_code_install` + is created. There are a few different ways to install ScanCode: +- :ref:`app_install` [Recommended for newcomers] +- :ref:`docker_install` +- :ref:`pip_install` +- :ref:`source_code_install` -#. Now you can either follow the instructions for the recommended :ref:`app_install` method , - or run ``pip install scancode-toolkit[full]`` like that in the :ref:`pip_install` documentation. - Alternatively, you can also :ref:`source_code_install`. -#. Run ``scancode -h`` to make sure Scancode was installed properly. +#. Run ``scancode -h`` to make sure ScanCode was installed properly. If this shows any Error, refer the `Common Installation Errors Issue `_ for common errors. @@ -107,7 +84,7 @@ Before you start using ScanCode Scan a Codebase ^^^^^^^^^^^^^^^ -Once you are all set up with Scancode Toolkit, i.e. Running ``scancode -h`` shows the +Once you are all set up with ScanCode-Toolkit, i.e. Running ``scancode -h`` shows the :ref:`cli_help_text`, you can start scanning files or a codebase. #. Refer :ref:`synopsis_quickstart` for commonly used scan commands, and commonly used @@ -121,7 +98,7 @@ Once you are all set up with Scancode Toolkit, i.e. Running ``scancode -h`` show follow the basic instructions. #. ScanCode generates output files with scan results. You can visualize ``JSON`` result files using - `Scancode Workbench `_. Follow this tutorial :ref:`how_to_visualize_scan_results` + `ScanCode Workbench `_. Follow this tutorial :ref:`how_to_visualize_scan_results` to visualize the scan results. .. _newcomer_scancode_tips: @@ -129,7 +106,7 @@ Once you are all set up with Scancode Toolkit, i.e. Running ``scancode -h`` show Use ScanCode Better ^^^^^^^^^^^^^^^^^^^ -#. Go through all the options in the page :ref:`cli_list_options`, to know about Scancode Command +#. Go through all the options in the page :ref:`cli_list_options`, to know about ScanCode Command Line options. You can then modify the Scan according to your requirements. .. _newcomer_all_tutorials: @@ -156,9 +133,9 @@ The How-To's are: ScanCode Versions ^^^^^^^^^^^^^^^^^ -#. You can see all Scancode Toolkit versions on the `GitHub release page `_. +#. You can see all ScanCode-Toolkit versions on the `GitHub release page `_. #. Read the `CHANGELOG `_ for more information on specific releases. -#. If you want to use/test a specific version of Scancode Toolkit, you can follow the instructions +#. If you want to use/test a specific version of ScanCode-Toolkit, you can follow the instructions in :ref:`source_code_install` docs. ---- @@ -168,8 +145,8 @@ ScanCode Versions Learn more about ScanCode Toolkit --------------------------------- -Here we give an introduction on the Scancode Toolkit Documentation Sections that can help you to -learn more about Scancode Toolkit. +Here we give an introduction on the ScanCode-Toolkit Documentation Sections that can help you to +learn more about ScanCode-Toolkit. .. _newcomer_cli_ref: @@ -192,7 +169,7 @@ also the extractcode options. .. _newcomer_explanations: -How Scancode Works +How ScanCode Works ^^^^^^^^^^^^^^^^^^ This section has documentation on :ref:`explain_how_scancode_works`. @@ -203,7 +180,7 @@ Plugins ^^^^^^^ 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. +ScanCode capabilities, and developers can code their own plugins according to their requirements. This section has documentation on: @@ -218,7 +195,7 @@ This section has documentation on: Contribute ---------- -If you are looking to Contribute to Scancode Toolkit, this is where you start. +If you are looking to Contribute to ScanCode-Toolkit, this is where you start. .. _newcomer_contribute_general_info: @@ -234,7 +211,7 @@ General Information Contribute Code ^^^^^^^^^^^^^^^ -If you haven't contributed to Scancode Toolkit refer :ref:`newcomer_good_first_issue`. +If you haven't contributed to ScanCode-Toolkit refer :ref:`newcomer_good_first_issue`. To determine where to contribute, you can refer: @@ -249,17 +226,17 @@ Good First Issues ^^^^^^^^^^^^^^^^^ A `good first issue `_ -means it's recommended for people who haven't contributed to Scancode Toolkit before. +means it's recommended for people who haven't contributed to ScanCode-Toolkit before. .. _newcomer_add_functionalirty: Add new Functionality/Enhancement to ScanCode ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -There are two main paths you can follow to add a new functionality to Scancode. +There are two main paths you can follow to add a new functionality to ScanCode. They are: -#. Add the functionality to Scancode itself. +#. Add the functionality to ScanCode itself. #. Add plugins if the functionality is very much application dependent. Refer `enhancement issues `_ for the first type of @@ -272,9 +249,9 @@ Update our Documentation ^^^^^^^^^^^^^^^^^^^^^^^^ Maintaining a comprehensive, accurate, updated and effective documentation is very important -as that directly affects the acceptability of Scancode Toolkit. +as that directly affects the acceptability of ScanCode-Toolkit. -To contribute to Scancode Toolkit Documentation, first refer the :ref:`contrib_doc_dev` section. +To contribute to ScanCode-Toolkit Documentation, first refer the :ref:`contrib_doc_dev` section. The sections in this page cover the following: diff --git a/docs/source/reference/available_package_parsers.rst b/docs/source/reference/available_package_parsers.rst index ca35c9c2acd..bdeacf49249 100644 --- a/docs/source/reference/available_package_parsers.rst +++ b/docs/source/reference/available_package_parsers.rst @@ -224,6 +224,13 @@ parsers in scancode-toolkit during documentation builds. - ``conan_conanfile_py`` - C++ - https://docs.conan.io/2.0/reference/conanfile.html + * - Conda metadata JSON in rootfs + - ``*conda-meta/*.json`` + - ``conda`` + - ``linux``, ``win``, ``mac`` + - ``conda_meta_json`` + - Python + - https://docs.conda.io/ * - Conda meta.yml manifest - ``*/meta.yaml`` - ``conda`` @@ -231,6 +238,15 @@ parsers in scancode-toolkit during documentation builds. - ``conda_meta_yaml`` - None - https://docs.conda.io/ + * - Conda yaml manifest + - ``*conda*.yaml`` + ``*env*.yaml`` + ``*environment*.yaml`` + - ``conda`` + - ``linux``, ``win``, ``mac`` + - ``conda_yaml`` + - Python + - https://docs.conda.io/ * - CPAN Perl dist.ini - ``*/dist.ini`` - ``cpan`` @@ -728,14 +744,6 @@ parsers in scancode-toolkit during documentation builds. - ``pubspec_yaml`` - dart - https://dart.dev/tools/pub/pubspec - * - Conda yaml manifest - - ``*conda.yaml`` - ``*conda.yml`` - - ``pypi`` - - ``linux``, ``win``, ``mac`` - - ``conda_yaml`` - - Python - - https://docs.conda.io/ * - pip requirements file - ``*requirement*.txt`` ``*requirement*.pip`` diff --git a/docs/source/rst_snippets/custom_output_format.rst b/docs/source/rst_snippets/custom_output_format.rst index 25f81923e1b..e947a5995f0 100644 --- a/docs/source/rst_snippets/custom_output_format.rst +++ b/docs/source/rst_snippets/custom_output_format.rst @@ -54,6 +54,6 @@ Now the results are saved in ``output.txt`` and we can easily view them with ``h ] For a more elaborate template, refer this `default template `_ -given with Scancode, to generate HTML output with the ``--html`` output format option. +given with ScanCode, to generate HTML output with the ``--html`` output format option. Documentation on `Jinja templates `_. diff --git a/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst b/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst index 9f272c4750c..5fe1a47b083 100644 --- a/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst +++ b/docs/source/rst_snippets/warning_snippets/output_htmlapp_dep.rst @@ -1,5 +1,5 @@ .. WARNING:: - The html-app feature has been deprecated and you should use Scancode Workbench instead + The html-app feature has been deprecated and you should use ScanCode Workbench instead to visualize scan results. The official Repository `link `_. Also refer :ref:`how_to_visualize_scan_results`. diff --git a/docs/source/tutorials/how_to_format_scan_output.rst b/docs/source/tutorials/how_to_format_scan_output.rst index 00bf79f7d01..89d238ef281 100644 --- a/docs/source/tutorials/how_to_format_scan_output.rst +++ b/docs/source/tutorials/how_to_format_scan_output.rst @@ -1,9 +1,9 @@ .. _how_to_specify_output_format: -How to specify Scancode Output Format +How to specify ScanCode Output Format ===================================== -A basic overview of formatting Scancode Output is presented here. +A basic overview of formatting ScanCode Output is presented here. More information on :ref:`cli_output_format`. @@ -38,6 +38,6 @@ For more details on the HTML output format refer :ref:`output_html`. .. WARNING:: - The ``--html-app`` option has been deprecated, use Scancode Workbench instead. + The ``--html-app`` option has been deprecated, use ScanCode Workbench instead. .. include:: /rst_snippets/custom_output_format.rst diff --git a/docs/source/tutorials/how_to_run_a_scan.rst b/docs/source/tutorials/how_to_run_a_scan.rst index 9d0b09829f3..5895f153c09 100644 --- a/docs/source/tutorials/how_to_run_a_scan.rst +++ b/docs/source/tutorials/how_to_run_a_scan.rst @@ -2,7 +2,7 @@ How to Run a Scan ================= In this simple tutorial example, we perform a basic scan on the ``samples`` directory distributed -by default with Scancode. +by default with ScanCode. Prerequisites @@ -15,7 +15,7 @@ Looking into Files ------------------ As mentioned previously, we are going to perform the scan on the ``samples`` directory distributed -by default with Scancode Toolkit. Here's the directory structure and respective files: +by default with ScanCode-Toolkit. Here's the directory structure and respective files: .. image:: /tutorials/data/files_sample.png 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 index e501b124d83..c4a73f68560 100644 --- 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 @@ -14,7 +14,7 @@ Different Scans The following examples will use the ``samples`` directory that is provided with the `ScanCode Toolkit code `_. All examples will -be saved in the JSON format, which can be loaded into Scancode Workbench for visualization. See +be saved in the JSON format, which can be loaded into ScanCode Workbench for visualization. See :ref:`how_to_visualize_scan_results` for more information. Another output format option is a static html file. See :ref:`cli_output_format` for more information. diff --git a/docs/source/tutorials/how_to_visualize_scan_results.rst b/docs/source/tutorials/how_to_visualize_scan_results.rst index 041092a012a..b5b57841f80 100644 --- a/docs/source/tutorials/how_to_visualize_scan_results.rst +++ b/docs/source/tutorials/how_to_visualize_scan_results.rst @@ -3,14 +3,14 @@ How to Visualize Scan results ============================= -To help visualize the scans, we have a dedicated tool `Scancode workbench `_ which is a desktop application that allows you to visualize and explore the results of one or more scans. It is a cross-platform application that runs on Windows, Mac OS X and Linux. It is built using the Electron framework and is built using Electron, Typescript & React +To help visualize the scans, we have a dedicated tool `ScanCode workbench `_ which is a desktop application that allows you to visualize and explore the results of one or more scans. It is a cross-platform application that runs on Windows, Mac OS X and Linux. It is built using the Electron framework and is built using Electron, Typescript & React Detailed Installation and Usage guide can be found here - :ref:`scancode-workbench:getting-started` .. 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 - 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 + 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 `_. ..