github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1661 from robertlagrant/master

Browse source 
Change docs wording on cache regeneration on pickle errors.
Fixes #1630
This commit is contained in:
Ondrej Grover 2015-03-13 15:23:07 +01:00
commit 3d5f01ba3f
1 changed files with 4 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/settings.rst
View file

@ -847,13 +847,11 @@ can be invoked by passing the ``--archive`` flag).
The cache files are Python pickles, so they may not be readable by The cache files are Python pickles, so they may not be readable by
different versions of Python as the pickle format often changes. If different versions of Python as the pickle format often changes. If
such an error is encountered, the cache files have to be rebuilt by such an error is encountered, it is caught and the cache file is
removing them and re-running Pelican, or by using the Pelican rebuilt automatically in the new format. The cache files will also be
command-line option ``--ignore-cache``. The cache files also have to rebuilt after the ``GZIP_CACHE`` setting has been changed.
be rebuilt when changing the ``GZIP_CACHE`` setting for cache file
reading to work properly.
The ``--ignore-cache`` command-line option is also useful when the The ``--ignore-cache`` command-line option is useful when the
whole cache needs to be regenerated, such as when making modifications whole cache needs to be regenerated, such as when making modifications
to the settings file that will affect the cached content, or just for to the settings file that will affect the cached content, or just for
debugging purposes. When Pelican runs in autoreload mode, modification debugging purposes. When Pelican runs in autoreload mode, modification