Skip to content

Commit

Permalink
Merge pull request #711 from cole-miller/readme-remove-build-raft
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
cole-miller authored Oct 16, 2024
2 parents e80eada + 7643fdf commit 76f1e7c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 17 deletions.
8 changes: 3 additions & 5 deletions .github/workflows/packages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,9 @@ jobs:
sudo apt-get update -qq
sudo apt-get install -qq debhelper devscripts gnupg
- name: Work around GPG issue
run: |
mkdir -p ~/.gnupg
echo "pinentry-mode loopback" >~/.gnupg/gpg.conf
# Note for future maintainers: the secret key should be stored
# in the GHA secret in ASCII-armored form, and must not be
# password-protected.
- name: Setup GPG signing key
env:
PPA_SECRET_KEY: ${{ secrets.PPA_SECRET_KEY }}
Expand Down
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Contributing to dqlite

The dqlite team welcomes external contributions via GitHub pull
requests. To get your PR merged, you need to sign [Canonical's
contributor license agreement (CLA)][cla]. This is straightforward to
do once you have an account on [Launchpad][lp]; if you don't, you can
create one [here][signup].
The dqlite team welcomes contributions via GitHub pull requests. To get your PR
merged, you need to sign [Canonical's contributor license agreement
(CLA)][cla]. This is straightforward to do once you have an account on
[Launchpad][lp]; if you don't, you can create one [here][signup].

[cla]: https://ubuntu.com/legal/contributors
[lp]: https://launchpad.net
Expand Down
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ library and headers as follows:

```
$ autoreconf -i
$ ./configure --enable-build-raft
$ ./configure
$ make
$ sudo make install
```
Expand All @@ -112,13 +112,9 @@ to enable the linker to find `libdqlite.so`. To install to a different prefix,
replace the configure step with something like

```
$ ./configure --enable-build-raft --prefix=/usr
$ ./configure --prefix=/usr
```

The `--enable-build-raft` option causes dqlite to use its bundled Raft
implementation instead of linking to an external libraft; the latter is a
legacy configuration that should not be used for new development.

Building for static linking
---------------------------

Expand All @@ -141,7 +137,7 @@ The `contrib/build-static.sh` script demonstrates building and
testing dqlite with all dependencies (including libc) statically
linked.

Usage Notes
Usage notes
-----------

Detailed tracing will be enabled when the environment variable
Expand Down

0 comments on commit 76f1e7c

Please sign in to comment.