Skip to content

Commit e21bf56

Browse files
rohanKanojiagbraad
authored andcommitted
doc : add instructions in development guide to deal with missing gpgme 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]>
1 parent 59b8279 commit e21bf56

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

content/Developing.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,36 @@ If you need to update mocks use:
8484
```bash
8585
$ make generate_mocks
8686
```
87+
88+
## Troubleshooting errors when running unit tests via IDE
89+
90+
When running tests from IDE, you might encounter this error:
91+
92+
```shell
93+
pkg-config --cflags -- gpgme
94+
Package gpgme was not found in the pkg-config search path.
95+
Perhaps you should add the directory containing `gpgme.pc'
96+
to the PKG_CONFIG_PATH environment variable
97+
No package 'gpgme' found
98+
pkg-config: exit status 1
99+
```
100+
101+
In order to resolve this you need to install [gpgme](https://github.com/proglottis/gpgme)
102+
103+
### Installing gpgme on Linux
104+
105+
You need to install `libgpgme-dev` using your Linux distribution's package installer tool (`dnf`/`apt`)
106+
107+
Here is an example for Fedora:
108+
```shell
109+
sudo dnf -y install libgpgme-dev
110+
```
111+
112+
### Installing gpgme on MacOS
113+
114+
You need to install `gpgme` on macOS.
115+
116+
Here is an example using homebrew:
117+
```shell
118+
brew install gpgme
119+
```

0 commit comments

Comments
 (0)