Skip to content

Commit b088d67

Browse files
committed
Add Makefile section to README-dev.md
1 parent 5833be1 commit b088d67

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README-dev.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,17 @@ Once you have installed the above software, you can build and preview the docume
1414
## Custom commands
1515

1616
To generate the reference documentation of the driver, run the command `make javadoc`. This command generates the reference documentation using the Javadoc tool in the `_build/dirhtml/<VERSION>/api` directory.
17+
18+
## Using the Makefile
19+
20+
Most day-to-day tasks are wrapped in the top-level `Makefile` so you do not have to remember long Maven invocations. Common targets include:
21+
22+
- `make download-all-dependencies` pre-fetches all Maven artifacts to warm local caches.
23+
- `make compile-all` compiles main and test sources without running tests, skipping format, clirr, and animal-sniffer checks for speed.
24+
- `make test-unit` runs the fast unit-test suite; use `MVNCMD` to tweak the underlying Maven command if needed.
25+
- `make test-integration-scylla` and `make test-integration-cassandra` execute CCM-backed integration suites. Export `SCYLLA_VERSION` or `CASSANDRA_VERSION` to pin specific server versions before invoking.
26+
- `make check` executes `mvn verify -DskipTests` for static analysis, while `make fix` applies code formatters via `mvn fmt:format`.
27+
- `make fix` executes `mvn fmt:format` to format the code.
28+
- `make clean` removes Maven targets, shaded artifacts, and release backups to reset the tree.
29+
30+
The Makefile automatically installs the shaded Guava dependency and, for integration tests, bootstraps the appropriate CCM toolchain and raises kernel `aio-max-nr` when required. If a target fails because the toolchain is missing, rerun after installing the prerequisites highlighted in the target output.

0 commit comments

Comments
 (0)