pimutils / pimutils/khal

Cache DB is only updated when directory timestamp changes

Open
#1,099 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: documentation type: enhancement
Dominant language
Python
Stars
3.1k
Forks
233
Avg merge
1h 44m
Merged PRs (30d)
1

Description

This assumes that my calendar is a directory of .ics files.
Can someone please explain why the cache db is only updated when the timestamp of the directory changes, but not, when the timestamp of a file within that directory (i.e. an event) changes?
I'm assuming it's for performance reasons because these directories can get quite large.
I think this behaviour should be documented in a clear way, as I spent quite some time trying to figure out what was going on when my (manual) change of an .ics file wasn't recognized by khal.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a documentation file, test, or entry point. First trace how khal updates the cache DB for directory and .ics file timestamps, then document when file changes are or are not recognized, including the performance rationale if confirmed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.