Skip to content
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.

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

Improves ergonomics when pkg-config is missing and updates docs #171

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

Conversation

sgg
Copy link

@sgg sgg commented Jun 21, 2019

pkg-config is needed to build hsbench and hscollider as it's used to dynamically link sqlite and libpcre however this is not outlined by the build process nor in the dev docs (outlined in #135).

This PR includes two changes:

  1. I've updated the CMake files to print an explicit log message when pkg-config is missing
  2. I've added a section to the Getting Started section of the docs that outlines the optional dependencies and what they are used for.

Before

$ skathi ~/w/sgg-hyperscan git:master ❯❯❯ cmake -G Ninja
...
-- Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)
-- PCRE version 8.41 or above not found
-- PCRE 8.41 or above not found
-- Looking for pthread.h
-- Looking for pthread.h - found
-- Looking for pthread_create
-- Looking for pthread_create - found
-- Found Threads: TRUE
-- looking for sqlite3 in source tree
--   no sqlite3 in source tree
-- sqlite3 not found, not building hsbench
-- PCRE 8.41 not found, not building hscollider

After

$ skathi ~/w/sgg-hyperscan git:dep-docs ❯❯❯ cmake -G Ninja
-- Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)
-- Could not find pkg-config. Will not generate pkg-config metadata for libhs.
...
-- Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)
-- pkg-config was not found. This is required to dynamically link libpcre.
-- PCRE 8.41 or above not found
-- Could NOT find PkgConfig (missing: PKG_CONFIG_EXECUTABLE)
-- pkg-config was not found. This is required to dynamically link sqlite3.
-- looking for sqlite3 in source tree
--   no sqlite3 in source tree
-- sqlite3 not found, not building hsbench
-- PCRE 8.41 not found, not building hscollider

sgg added 2 commits June 21, 2019 13:38
pkg-config is required to dynamically link sqlite and PCRE for building
`hsbench` and `hscollider`, however this is not surfaced during the
build process.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant