diff options
| author | Jean Abou-Samra <jean@abou-samra.fr> | 2023-02-23 13:44:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-23 13:44:22 +0100 |
| commit | e589fee754a76e9600dcb42baaeb3372d9e163d7 (patch) | |
| tree | 34a4a1bef36b0d1b65b8925e9751a9ee3bdc7281 /README.rst | |
| parent | 1e85f7c2ad2edfeae7f0c566163931324f64f949 (diff) | |
| download | pygments-git-e589fee754a76e9600dcb42baaeb3372d9e163d7.tar.gz | |
Replace Makefile with tox (#2331)
Porting notes:
- tox handles Python environments automatically. Remove a bit of PYTHONPATH
manipulation (that was using Python 2 code which always failed!)
- No `clean` target: `git clean -xdf` should fit the bill.
- No `reindent` target: the `reindent.py` script it was using does not
exist (anymore?).
- No equivalent of tox-test-coverage, which was an artifact of the past,
using nose. Instead, the test-coverage target only is ported, which
uses pytest, and works.
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -16,13 +16,13 @@ Documentation ... can be found online at https://pygments.org/ or created with Sphinx by :: - make docs + tox -e doc By default, the documentation does not include the demo page, as it requires having Docker installed for building Pyodide. To build the documentation with the demo page, use :: - WEBSITE_BUILD=1 make docs + tox -e web-doc The initial build might take some time, but subsequent ones should be instant because of Docker caching. @@ -59,12 +59,12 @@ significant amounts of memory. This can subsequently be used to perform a remote denial-of-service attack on the server if the processes are not terminated quickly. -Unfortunately, it's practically impossible to harden Pygments itself against -those issues: Some regular expressions can result in "catastrophic +Unfortunately, it's practically impossible to harden Pygments itself against +those issues: Some regular expressions can result in "catastrophic backtracking", but other bugs like incorrect matchers can also cause similar problems, and there is no way to find them in an automated fashion -(short of solving the halting problem.) Pygments has extensive unit tests, -automated randomized testing, and is also tested by `OSS-Fuzz <https://github.com/google/oss-fuzz/tree/master/projects/pygments>`_, +(short of solving the halting problem.) Pygments has extensive unit tests, +automated randomized testing, and is also tested by `OSS-Fuzz <https://github.com/google/oss-fuzz/tree/master/projects/pygments>`_, but we will never be able to eliminate all bugs in this area. Our recommendations are: |