Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation bugs #317

Merged
merged 3 commits into from
Jan 11, 2022
Merged

Fix documentation bugs #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9162269
Fix documentation bugs
sushantmimani Jan 8, 2022
0771fdc
Address review comments & fix warnings
sushantmimani Jan 10, 2022
ae6d435
Merge branch 'main' into doc-fixes
rbailey-godaddy Jan 11, 2022
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
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,11 @@ Misc:
--include-paths and --exclude-paths

v2.10.1 - 27 December 2021
------------
--------------------------

Bug fixes:

*[#309](https://github.com/godaddy/tartufo/pull/309) Fixes an issue where verbose output display
* [#309](https://github.com/godaddy/tartufo/pull/309) Fixes an issue where verbose output display
would error out if the new-style entropy exclusion pattern was used

v2.10.0 - 3 November 2021
Expand Down
1 change: 1 addition & 0 deletions docs/source/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ in the config file:
scan-local-repo file://path/to/my/repo.git
As of version 3.0, a new format for specifying paths has been added.

.. code-block:: toml
[tool.tartufo]
Expand Down
17 changes: 9 additions & 8 deletions docs/source/upgrading3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,16 @@ checkouts.
Nonfunctional Options
+++++++++++++++++++++

``tartufo`` release 3 uses
.. _pygit2: https://pygit2.readthedocs.io/en/latest/
instead of
.. _GitPython: https://gitpython.readthedocs.io/en/stable/
to access git repositories. While this provides vastly improved performance with
``tartufo`` release 3 uses `pygit2`_ instead of `GitPython`_ to access git repositories.
While this provides vastly improved performance with
generally equivalent functionality, some less-frequently used options require
reimplementation and currently are nonfunctional. We plan to provide either
replacements or reimplementations in the future.

The ``--since-commit`` option is intended to restrict scans to a subset of
repository history; the ``--max-depth`` option provides roughly the same
functionality specified differently. Both options are ignored by ``tartufo``
release 3. Refer to
.. _#267: https://github.com/godaddy/tartufo/issues/267
for more information about this topic.
release 3. Refer to `#267`_ for more information about this topic.

Changes to Default Behavior
---------------------------
Expand Down Expand Up @@ -183,3 +178,9 @@ sensitivity for both encodings consistently, using a scale of 0-100. To convert:

Users who require different base64 and hexadecimal sensitivities should open an
issue that explains their use case.

.. _TOML: https://toml.io/
.. _array of tables: https://toml.io/en/v1.0.0#array-of-tables
.. _pygit2: https://pygit2.readthedocs.io/en/latest/
.. _GitPython: https://gitpython.readthedocs.io/en/stable/
.. _#267: https://github.com/godaddy/tartufo/issues/267