Skip to content

Dvi caching #10268

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.

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

Closed
wants to merge 7 commits into from
Closed
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
8 changes: 8 additions & 0 deletions doc/api/next_api_changes/2018-02-16-JKS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
dviread changes
---------------

The ``format`` keyword argument to ``dviread.find_tex_file`` has been
deprecated. The function without the ``format`` argument, as well as
the new ``dviread.find_tex_files`` function, cache their results in
``texsupport.N.db`` in the cache directory to speed up dvi file
processing.
22 changes: 22 additions & 0 deletions doc/users/next_whats_new/texsupport_cache.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
TeX support cache
-----------------

The `usetex` feature sends snippets of TeX code to LaTeX and related
external tools for processing. This causes a nontrivial number of
helper processes to be spawned, which can be slow on some platforms.
A new cache database helps reduce the need to spawn these helper
processes, which should improve `usetex` processing speed.

The new cache files
~~~~~~~~~~~~~~~~~~~

The cache database is stored in a file named `texsupport.N.db` in the
standard cache directory (traditionally `$HOME/.matplotlib` but
possibly `$HOME/.cache/matplotlib`), where `N` stands for a version
number. The version number is incremented when new kinds of items are
added to the caching code, in order to avoid version clashes when
using multiple different versions of Matplotlib. The auxiliary files
`texsupport.N.db-wal` and `texsupport.N.db-shm` help coordinate usage
of the cache between concurrently running instances. All of these
cache files may be deleted when Matplotlib is not running, and
subsequent calls to the `usetex` code will recompute the TeX results.
10 changes: 5 additions & 5 deletions doc/users/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ revision, see the :ref:`github-stats`.
..
For a release, add a new section after this, then comment out the include
and toctree below by indenting them. Uncomment them after the release.
.. include:: next_whats_new/README.rst
.. toctree::
:glob:
:maxdepth: 1
.. include:: next_whats_new/README.rst
.. toctree::
:glob:
:maxdepth: 1

next_whats_new/*
next_whats_new/*


New in Matplotlib 2.2
Expand Down
Loading