Skip to content

Commit

Permalink
doc : add instructions in development guide to deal with missing gpgm…
Browse files Browse the repository at this point in the history
…e package

While running unit tests from GoLang, I had encountered this error
multiple times. I thought it's better to document this so that some
newcomer doesn't face this issue.

Signed-off-by: Rohan Kumar <[email protected]>
  • Loading branch information
rohanKanojia authored and gbraad committed Mar 9, 2025
1 parent 59b8279 commit e21bf56
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions content/Developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,36 @@ If you need to update mocks use:
```bash
$ make generate_mocks
```

## Troubleshooting errors when running unit tests via IDE

When running tests from IDE, you might encounter this error:

```shell
pkg-config --cflags -- gpgme
Package gpgme was not found in the pkg-config search path.
Perhaps you should add the directory containing `gpgme.pc'
to the PKG_CONFIG_PATH environment variable
No package 'gpgme' found
pkg-config: exit status 1
```
In order to resolve this you need to install [gpgme](https://github.com/proglottis/gpgme)
### Installing gpgme on Linux
You need to install `libgpgme-dev` using your Linux distribution's package installer tool (`dnf`/`apt`)
Here is an example for Fedora:
```shell
sudo dnf -y install libgpgme-dev
```

### Installing gpgme on MacOS

You need to install `gpgme` on macOS.

Here is an example using homebrew:
```shell
brew install gpgme
```

0 comments on commit e21bf56

Please sign in to comment.