diff --git a/docs/source/cli-reference/core-options.rst b/docs/source/cli-reference/core-options.rst index c2fc6ae9e0..ab53726e28 100644 --- a/docs/source/cli-reference/core-options.rst +++ b/docs/source/cli-reference/core-options.rst @@ -84,6 +84,20 @@ Comparing Progress Message Options This inputs the scan results from ``sample.json``, runs the post-scan plugin ``--classify`` and outputs the results for this scan to ``sample_2.json``. + You can also convert the input ``.json`` file to other output format + without using any scan option. + + For instance,:: + + scancode --from-json sample.json --yaml sample.yml + + The above command takes ``sample.json`` as input and generates file in ``.yml`` formats. + + .. note:: + + This only works for options that require only the input JSON file; + options that rely on other files or source code will not work. + ---- .. _max_in_memory_option: diff --git a/docs/source/cli-reference/list-options.rst b/docs/source/cli-reference/list-options.rst index 8e2f14fa12..17fb1e2b67 100644 --- a/docs/source/cli-reference/list-options.rst +++ b/docs/source/cli-reference/list-options.rst @@ -3,7 +3,8 @@ 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-Toolkit options, +arranged in various sections. The sections are as follows: - Basic Scan Options @@ -13,25 +14,12 @@ The sections are as follows: - Pre-Scan Options - Post-Scan Options -There's also another section for ``extractcode`` options. - -The order of the sections and all their options is the same as in the :ref:`cli_help_text`, -available in the command line. - .. _cli_basic: .. include:: /rst_snippets/basic_options.rst ---- -.. include:: /rst_snippets/extract.rst - ----- - -.. include:: /rst_snippets/scancode-reindex-licenses.rst - ----- - .. include:: /rst_snippets/core_options.rst ---- diff --git a/docs/source/rst_snippets/core_options.rst b/docs/source/rst_snippets/core_options.rst index 453763ca57..a96dcbfc7e 100644 --- a/docs/source/rst_snippets/core_options.rst +++ b/docs/source/rst_snippets/core_options.rst @@ -25,3 +25,12 @@ All "Core" Scan Options including and below the starting point. INTEGER must be positive or zero for no limit. [Default: 0] + + +.. note:: + + For local machines running additional applications like browsers, IDEs, + or chat tools, it’s recommended to allocate (number of CPUs) minus 2, + or fewer, based on current CPU usage for optimal stability. + +