Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ report here). We are now just reporting a flat mapping here, and all the
rule details are also not present in the license match, and only available
as an optional reference.

See this before/after comparision to see how the license data in results has
See this before/after comparison to see how the license data in results has
evolved.

Before::
Expand Down Expand Up @@ -536,12 +536,12 @@ This is now default with the CLI option ``--license``, which references from
the match License-level Data and LicenseDB-level Data, and removes the actual data from
the matches, and adds them to two top-level lists.

Comparision: Before/After license references
Comparison: Before/After license references
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To compare how the license output data changes between when license references are not collected
vs when they are collected (which is default from version 32.x), check out the before/after
comparision below.
comparison below.

Before::

Expand Down
26 changes: 13 additions & 13 deletions docs/source/getting-started/contribute/contributing-code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ TL;DR:
- Contributions comes as bugs/questions/issues and as pull requests.
- Source code and runtime data are in the /src/ directory.
- Test code and test data are in the /tests/ directory.
- Datasets (inluding licenses) and test data are in /data/ sub-directories.
- Datasets (including licenses) and test data are in /data/ sub-directories.
- We use DCO signoff in commit messages, like Linux does.
- Porting ScanCode to other OS (FreeBSD is supported, etc.) is possible. Enter an issue for help.

Expand Down Expand Up @@ -99,7 +99,7 @@ Another useful option after a test run with some failures is to re-run only the
failed tests with the ``--lf`` option, for instance: ``pytest -vvs --lf`` would
only run only test functions that failed in the previous run.

Because we have a lot of tests (over 29,000), we organized theses in test suites
Because we have a lot of tests (over 29,000), we organized these in test suites
using pytest markers that are defined in the ``conftest.py`` pytest plugin.
These are enabled by adding a ``--test-suite`` option to the pytest command.

Expand All @@ -109,8 +109,8 @@ These are enabled by adding a ``--test-suite`` option to the pytest command.
extensive data-driven and data validations (for package, copyright and license
detection)

In some cases we need to regenerate test data when expected behavious/result data
structures change, and we have an environement variable to regenerate test data.
In some cases we need to regenerate test data when expected behaviour/result data
structures change, and we have an environment variable to regenerate test data.
`SCANCODE_REGEN_TEST_FIXTURES` is present in `scancode_config` and this can be
set to regenerate test data for specific tests like this:

Expand All @@ -124,7 +124,7 @@ If test data is regenerated, it is important to review the diff for test files a
carefully go through all of it to make sure there are no unintended changes there,
and then commit all the regenerated test data.

To help debug in scancode, we use logging. There are different environement variables
To help debug in scancode, we use logging. There are different environment variables
you need to set to turn on logging. In packagedcode::

``SCANCODE_DEBUG_PACKAGE=yes pytest -vvs tests/packagedcode/ --lf``
Expand All @@ -134,9 +134,9 @@ logging variables and shows code execution paths by logging and printing the log
in the terminal. If debugging full scans run by click, you have to raise exceptions
in addition to setting the TRACE to enable logging.

.. _scancode_toolkit_development_thirdparty_libraries:
.. _scancode_toolkit_development_Third party_libraries:

Thirdparty libraries and dependencies management
Third party libraries and dependencies management
-----------------------------------------------------

ScanCode uses the ``configure`` and ``configure.bat`` scripts to install a
Expand All @@ -157,7 +157,7 @@ from ``setup.cfg``.
And to ensure that we also all use well known version of the core virtualenv,
pip, setuptools and wheel libraries, we use the ``virtualenv.pyz`` Python
zipp app from https://github.com/pypa/get-virtualenv/tree/main/public and
store it in the Git repo in the ``etc/thirdparty`` directory.
store it in the Git repo in the ``etc/Third party`` directory.

We bundle pre-built bundled native binaries as plugins which are installed as
wheels. These binaries are organized by OS and architecture; they ensure that
Expand All @@ -170,18 +170,18 @@ https://github.com/aboutcode-org/scancode-plugins

ScanCode app archives should not require network access for installation or
configuration of its third-party libraries and dependencies. To enable this,
we store bundled thirdparty components and libraries in the ``thirdparty``
we store bundled Third party components and libraries in the ``Third party``
directory of released app archives; this is done at build time.
These dependencies are stored as pre-built wheels. These wheels are sometimes
built by us when there is no wheel available upstream on PyPI. We store all
these prebuilt wheels with corresponding .ABOUT and .LICENSE files in
https://github.com/nexB/thirdparty-packages/tree/main/pypi which is published
for download at https://thirdparty.aboutcode.org/pypi/
https://github.com/nexB/Third party-packages/tree/main/pypi which is published
for download at https://Third party.aboutcode.org/pypi/

Because this is used by the configure script, all the thirdparty dependencies
Because this is used by the configure script, all the Third party dependencies
used in ScanCode MUST be available there first. Therefore adding a new
dependency means requesting a merge/PR in
https://github.com/nexB/thirdparty-packages/ first that contains all the
https://github.com/nexB/Third party-packages/ first that contains all the
recursive dependencies.

There are utility scripts in ``etc/release`` that can help with the dependencies
Expand Down
6 changes: 3 additions & 3 deletions docs/source/getting-started/contribute/contributing-docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ AboutCode documentation uses
`Intersphinx <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_
to link to other Sphinx Documentations, to maintain links to other Aboutcode Projects.

To link sections in the same documentation, standart reST labels are used. Refer
To link sections in the same documentation, standard reST labels are used. Refer
`Cross-Referencing <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html>`_
for more information.

Expand All @@ -143,7 +143,7 @@ For example::

It refers to the section itself, see :ref:`my-reference-label`.

Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then referance
Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then reference
these labels from another Sphinx Documentation, hosted in different locations.

You just have to add the following in the ``conf.py`` file for your Sphinx Documentation, where you
Expand Down Expand Up @@ -183,7 +183,7 @@ For more information, refer this tutorial named

.. _contributing-docs-style-conventions:

Style Conventions for the Documentaion
Style Conventions for the Documentation
--------------------------------------

1. Headings
Expand Down
4 changes: 2 additions & 2 deletions docs/source/getting-started/contribute/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Core features
^^^^^^^^^^^^^

- |white_check_mark| pre scan filtering (ignore binaries, etc)
- |white_check_mark| pre/post/ouput plugins! (worked as part of the GSoC by @yadsharaf )
- |white_check_mark| pre/post/output plugins! (worked as part of the GSoC by @yadsharaf )
- |white_check_mark| scan plugins (e.g. plugins that run a scan to collect data)
- |white_check_mark| support Python 3 #295
- |clock1030| transparent archive extraction (as opposed to on-demand with extractcode)
Expand Down Expand Up @@ -110,7 +110,7 @@ Packaging

- |white_large_square| simpler installation, automated installer
- |white_check_mark| distro-friendly packaging
- |clock1030| unbundle and package as multiple libaries (commoncode, extractcode, etc)
- |clock1030| unbundle and package as multiple libraries (commoncode, extractcode, etc)

Documentation
^^^^^^^^^^^^^
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ it is recommended to run the help command.

For use in development, run instead ``configure --dev``. If your encounter
issues while configuring a previous version, use ``configure --clean`` to
clean and reset your enviroment. After that, run ``configure`` again.
clean and reset your environment. After that, run ``configure`` again.
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ and other options.

.. note::

Add rules in a local developement installation and run `scancode-reindex-licenses`
Add rules in a local development installation and run `scancode-reindex-licenses`
to make sure we reindex the rules and this validates the new licenses.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ How to generate attribution doc from a ScanCode scan
====================================================

Users can use an Open Source Project "AboutCode Toolkit" to generate
attrbution document from a ScanCode scan.
attribution document from a ScanCode scan.

Read more about AboutCode Toolkit here: https://aboutcode-toolkit.readthedocs.io/.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _how-to-install-new-license-plugin:

How to install external licenses to use in license dectection
How to install external licenses to use in license detection
=============================================================

Users can install external licenses and rules in the form of:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/reference/scancode-cli/cli-basic-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Quick reference

It adds the following attributes to the top-level in results:

1. ``packages``: This is a mapping of package data with all the atrributes
1. ``packages``: This is a mapping of package data with all the attributes
present in file level ``package_data`` with the following extra attributes:
``package_uid``, ``datafile_paths`` and ``datasource_ids``.

Expand Down Expand Up @@ -409,7 +409,7 @@ Quick reference
``--email``
-----------

The ``--email`` option detects and reports email adresses present in scanned files.
The ``--email`` option detects and reports email addresses present in scanned files.

It adds the ``emails`` attribute to the file data with the following attributes:
``email`` with the actual email that was present in the file, ``start_line`` and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -584,7 +584,7 @@ for ScanCode Version 32.0.0.
help_group: post-scan, name: license_policy: --license-policy
help: Load a License Policy file and apply it to the scan at the Resource level.
doc:
Add the "license_policy" attribute to a resouce if it contains a
Add the "license_policy" attribute to a resource if it contains a
detected license key that is found in the license_policy.yml file


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -816,7 +816,7 @@ To see all plugins available via command line help, use ``--plugins``.

scancode -clipeu --json-pp strapi.json strapi-main/ --tallies --facet dev="*.js" --facet dev="*.ts" --tallies-by-facet

We have used the `github:strapi/strapi <https://github.com/strapi/strapi>`_ project to generate exmaple results for
We have used the `github:strapi/strapi <https://github.com/strapi/strapi>`_ project to generate example results for
this CLI option.

.. include:: /rst-snippets/note-snippets/cli-pre-scan-facet-core.rst
Expand Down
4 changes: 2 additions & 2 deletions docs/source/reference/scancode-supported-packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ parsers in scancode-toolkit during documentation builds.
- ``go_mod``
- Go
- https://go.dev/ref/mod
* - Go module cheksums file
* - Go module checksums file
- ``*/go.sum``
- ``golang``
- ``linux``, ``win``, ``mac``
Expand Down Expand Up @@ -859,7 +859,7 @@ parsers in scancode-toolkit during documentation builds.
``*/README.chromium``
``*/README.facebook``
``*/README.google``
``*/README.thirdparty``
``*/README.Third party``
- ``readme``
- ``linux``, ``win``, ``mac``
- ``readme``
Expand Down
2 changes: 1 addition & 1 deletion docs/source/rst-snippets/cli-post-scan-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@

--todo Identify license and package detections which needs
review as there are potential issues with the detections.
Lists all the unique ambigious detections with references
Lists all the unique ambiguous detections with references
to the file path and line numbers, detection details and
review comments to help explain the detection issue.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. note::

You can Output Scan Results in two different file formats simultaniously in one Scan. An
You can Output Scan Results in two different file formats simultaneously in one Scan. An
example - ``scancode -clpieu --json-pp output.json --html output.html samples``.

.. note::
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. note::

Plugins that are shown by using ``--plugins`` inlcude the following:
Plugins that are shown by using ``--plugins`` include the following:

#. Post-Scan Plugins (and, the following)
#. Pre-Scan Plugins
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorials/adding-a-post-scan-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Here are the major types of plugins:

3. Post-scan plugins (`scancode_post_scan` in entry points)

These are mainly data processing, summerizing and reporting plugins which
These are mainly data processing, summarizing and reporting plugins which
depend on all the results for the scan plugins. These add new codebase level
or file-level attributes, and even removes/modifies data as required
for consolidation or summarization. The base plugin class to be extended is ``PostScanPlugin``
Expand Down