diff options
| author | Jonas Bernoulli <jonas@sequoia-pgp.org> | 2021-04-16 15:52:20 +0200 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@sequoia-pgp.org> | 2021-04-22 16:25:36 +0200 |
| commit | 58025f5a0390c137fe972d2940c4bea1941ab055 (patch) | |
| tree | 432f8521d351fdc80a3db3ac2073f6e9c8ebcbc4 /README.md | |
| parent | 633f4475531a2fe5b1dd42c1ab6560470e4a0943 (diff) | |
make: Hide Makefile to avoid confusion.
- Those make targets that are useful to users are just wrappers
around the respective cargo commands, which means that they are
not really necessary. The additional targets are primarily of
use to Sequoia developers, which also means that they are not
very useful to users.
- That did not keep us from prominently advertising the use of
make as a recommended installation mechanism, and that in turn
contributed to some false expectations and confusion.
- For example, a packager used the Makefile because they thought
that that is what we would like them to do. Some users found it
surprising that "sudo make install" ended up running the target
"build-release" even though they had already build using "build".
- People who want to keep using make without every time having to
specify the name of the hidden Makefile can do so by creating a
symbolic link.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 1 insertions, 23 deletions
@@ -167,7 +167,7 @@ feature). Building Sequoia ================ -Using cargo +Using Cargo ----------- To build all Sequoia components, simply execute `cargo build @@ -175,28 +175,6 @@ To build all Sequoia components, simply execute `cargo build e.g. to build `sq`, run `cargo build [--release] -p sequoia-sq`, or build `sequoia-openpgp-ffi` to build a shared object with the C API. -Using the Makefile ------------------- - -We also consider the needs of packagers in times -where distribution support for packaging Rust projects is not yet -mature enough to handle a project like Sequoia. Therefore, we provide -a `Makefile` to simplify building, testing, and installing Sequoia. - -To build Sequoia, simply execute `make`. To run the test suites, -execute `make test` (or use the `check` alias). To install Sequoia, -use `make install`. The latter target honors `PREFIX` and `DESTDIR`. -Finally, to return your source tree to its pristine state, run `make -clean`. - -You can specify subdirectories to build individual modules, e.g. use -`make -Copenpgp-ffi install` to only install the shared object with -the C API. - -**Note:** By default the Python FFI bindings are also built. To skip -these add `PYTHON=disable` to all `make` invocations. E.g. `make -PYTHON=disable`. - Using Docker ------------ |