Skip to content

Update install guide to note issue #402 #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update install guide to note issue #402 #404

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59ca5c1
Update install instructions to note issue #402
bkuehnert May 7, 2023
b646032
Update README.md
bkuehnert May 7, 2023
e8b079e
Update protobuf clone command to specify branch 21.x
bkuehnert May 7, 2023
6003c08
Update README.md
bkuehnert May 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 24 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,29 @@ Common Lisp.

Common Lisp code for a given `.proto` file is generated by a plug-in for
`protoc`, the protocol buffer compiler. The plug-in is written in C++ and
requires the full version of Google's protocol buffer code to be installed
in order to build it, not just the precompiled protoc binaries.
requires Google's protocol buffer compiler as well as the development headers.

Download and build Google protobuf. Rough instructions are included here for
Unix systems. If you have any problems please see the
[protobuf installation instructions](https://github.com/protocolbuffers/protobuf/tree/master/src).
>**Warning** <br />
>Due to `protoc`'s dependence on Abseil in v22, the headers required to install
>the lisp plugin are no longer included. We are actively working on fixing
>this dependency ([#402](https://github.com/qitab/cl-protobufs/issues/402)).
>Until then, you will need to install a version of protobuf **older than v22,
>but at least v3.12**.

The compiler and development headers can be installed via package manager or
compiled from source.

### Ubuntu 22.04
```shell
sudo apt install protobuf-compiler libprotobuf-dev libprotoc-dev
```

### From source
Rough instructions are included here to install protoc v21 on Unix systems. If
you have any problems please see the [protobuf installation instructions](https://github.com/protocolbuffers/protobuf/blob/21.x/src/README.md).

```shell
$ git clone --recursive https://github.com/google/protobuf
$ git clone --recursive -b 21.x https://github.com/google/protobuf
$ cd protobuf
$ ./autogen.sh
$ ./configure --prefix=/usr/local
Expand All @@ -39,6 +53,10 @@ Common Lisp.

2. Build the Lisp `protoc` plugin

If you installed protoc via package manager, set `PROTOC_ROOT` to `/usr`. If
you installed it from source using the instructions above, use the value of
`--prefix` that you used.

```shell
$ cd cl-protobufs/protoc
$ PROTOC_ROOT=/usr/local make # value of --prefix, above
Expand Down