librdkafka icon indicating copy to clipboard operation
librdkafka copied to clipboard

Add links to public API headers at include/librdkafka

Open stertingen opened this issue 3 years ago • 2 comments

Also addressing https://github.com/edenhill/librdkafka/issues/3994, as an alternative to https://github.com/edenhill/librdkafka/pull/4004 and https://github.com/edenhill/librdkafka/pull/4012, based on feedback in https://github.com/edenhill/librdkafka/pull/4004#issuecomment-1303431978.

This PR adds symlinks to the public API headers at include/librdkafka/ to support #include <librdkafka/rdkafka.h> when using the library without installing it.

stertingen avatar Nov 04 '22 14:11 stertingen

Symlinks look broken on Windows, at least they do not work out-of-the-box. Trying with redirecting includes next.

stertingen avatar Nov 04 '22 16:11 stertingen

@edenhill Would you take another look at this? Thanks!

I switched away from symlinks as they did not work very well on Windows. They require special treatment with Git, so they do not work without the user doing some things. (See https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows) Introducing extra header files which include the actual files was the simpler and more robust approach.

stertingen avatar Nov 07 '22 15:11 stertingen

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

cla-assistant[bot] avatar Aug 21 '23 15:08 cla-assistant[bot]