Skip to content

Commit

Permalink
clarify 'metadata.mtime' usage and shortcomings (#2307)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikf committed Mar 8, 2022
1 parent bfa5e61 commit acbb0f5
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1980,7 +1980,7 @@ Description


extractor.skeb.sent-requests
-------------------------
----------------------------
Type
``bool``
Default
Expand Down Expand Up @@ -3128,6 +3128,16 @@ Description
Set modification times for generated metadata files
according to the accompanying downloaded file.

Enabling this option will only have an effect
*if* there is actual ``mtime`` metadata available, that is

* after a file download (``"event": "file"`` (default), ``"event": "after"``)
* when running *after* an ``mtime`` post processes for the same `event <metadata.event_>`__

For example, a ``metadata`` post processor for ``"event": "post"`` will
*not* be able to set its file's modification time unless an ``mtime``
post processor with ``"event": "post"`` runs *before* it.


mtime.event
-----------
Expand Down

0 comments on commit acbb0f5

Please sign in to comment.