diff options
author | Sean Allred <code@seanallred.com> | 2014-11-28 13:30:11 -0500 |
---|---|---|
committer | Sean Allred <code@seanallred.com> | 2015-01-04 16:32:39 -0500 |
commit | 14eadafd6388281085eb3330b9d7ee29a85ab8b2 (patch) | |
tree | 0e33a22a4b01afedefd19a5436c99ba22acd8c82 /sx-cache.el | |
parent | 3c05aae9915976e749591600f6e8f59cbccef1a4 (diff) |
Provide commentaries for each file
Diffstat (limited to 'sx-cache.el')
-rw-r--r-- | sx-cache.el | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/sx-cache.el b/sx-cache.el index e68397d..5f37d84 100644 --- a/sx-cache.el +++ b/sx-cache.el @@ -19,12 +19,18 @@ ;;; Commentary: -;; All caches are retrieved and set using symbols. The symbol should -;; be the sub-subpackage that is using the cache. For example, -;; `sx-pkg' would use `(sx-cache-get 'pkg)'. +;; This file handles the cache system. All caches are retrieved and +;; set using symbols. The symbol should be the sub-package that is +;; using the cache. For example, `sx-pkg' would use +;; +;; `(sx-cache-get 'pkg)' ;; ;; This symbol is then converted into a filename within -;; `sx-cache-directory'. +;; `sx-cache-directory' using `sx-cache-get-file-name'. +;; +;; Currently, the cache is written at every `sx-cache-set', but this +;; write will eventually be done by some write-all function which will +;; be set on an idle timer. ;;; Code: |