docs/omnibus-build-cache.md in omnibus-3.1.1 vs docs/omnibus-build-cache.md in omnibus-3.2.0.rc.1
- old
+ new
@@ -3,11 +3,11 @@
The omnibus project includes a project build caching mechanism that
reduces the time it takes to rebuild a project when only a few
components need to be rebuilt.
The cache uses git to snapshot the project tree after each software
-component build. The entire contents of the project's `install_path`
+component build. The entire contents of the project's `install_dir`
is included in the snaphot.
When rebuilding, omnibus walks the linearized component list and
replays the cache until the first item is encountered that needs to be
rebuilt. Items are rebuilt if the code changes (different version or
@@ -16,15 +16,15 @@
## Location of Cache Data ##
The default location of the cache (which is just a bare git
repository) is
-`/var/cache/omnibus/cache/install_path/$INSTALL_PATH`. You can
+`/var/cache/omnibus/cache/git_cache/$INSTALL_DIR`. You can
customize the location of the cache in the `omnibus.rb` config file
-using the key `install_path_cache_dir`. For example:
+using the key `git_cache_dir`. For example:
- install_path_cache_dir "/opt/ominbus-caches"
+ git_cache_dir "/opt/ominbus-caches"
## How It Works ##
Omnibus begins by loading all projects (see
`lib/omnibus.rb#expand_software`). The dependencies of each project
@@ -42,10 +42,10 @@
causes the system to rebuild everything further to the right in the
component list, you want to have your most frequently changed
components last to minimize rebuild churn.
Lightweight git tags are used as cache keys. After building a
-component, a tag name is computed in `install_path_cache.rb#tag`. The
+component, a tag name is computed in `GitCache#tag`. The
tag name has the format `#{name}-#{version}-#{digest}` where name and
version map to the component that was just built and digest is a
SHA256 value. The digest is computed by string-ifying the name/version
pairs of all components built prior to this component (keeping the
order of course) and prepending the entire contents of the component's