Skip to content

Commit 1bc1144

Browse files
pbhandar2meta-codesync[bot]
authored andcommitted
update the installation and testing doc
Summary: update the doc for installation and testing in website also added details like where to find the build files in README and website ___ overriding_review_checks_triggers_an_audit_and_retroactive_review Oncall Short Name: cachelib Differential Revision: D102682216 fbshipit-source-id: 7c7669237354dcbf73a51cbc0a2d670cdc0e1667
1 parent 5c27698 commit 1bc1144

3 files changed

Lines changed: 67 additions & 432 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ You can install system dependencies to save building them:
4343
git clone https://github.com/facebook/CacheLib
4444
# Install dependencies
4545
cd CacheLib
46-
sudo ./build/fbcode_builder/getdeps.py install-system-deps --recursive cachelib
46+
sudo python3 ./build/fbcode_builder/getdeps.py install-system-deps --recursive cachelib
4747

4848
If you'd like to see the packages before installing them:
4949

50-
./build/fbcode_builder/getdeps.py install-system-deps --dry-run --recursive cachelib
50+
python3 ./build/fbcode_builder/getdeps.py install-system-deps --dry-run --recursive cachelib
5151

5252
On other platforms or if on Linux and without system dependencies `getdeps.py` will mostly download and build them for you during the build step.
5353

@@ -77,6 +77,13 @@ By default `getdeps.py` will build the tests for cachelib. To run them:
7777

7878
python3 ./build/fbcode_builder/getdeps.py --allow-system-packages test cachelib
7979

80+
### Locating build output
81+
82+
`getdeps.py` installs build artifacts to a scratch directory. To find where CacheLib was installed:
83+
84+
python3 ./build/fbcode_builder/getdeps.py show-inst-dir cachelib
85+
86+
The install directory contains `bin/` (executables like `cachebench`), `lib/` (libraries), `include/` (headers), and `test_configs/` (sample configurations).
8087

8188

8289
## Contributing

0 commit comments

Comments
 (0)