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

Add vcpkg installation instructions #1097

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Adela0814
Copy link

pistache is available as a port in vcpkg, a C++ library manager that simplifies installation for pistache and other project dependencies. Documenting the install process here will help users get started by providing a single set of commands to build pistache, ready to be included in their projects.

We also test whether our library ports build in various configurations (dynamic, static) on various platforms (OSX, Linux, Windows: x86, x64, UWP, ARM) to keep a wide coverage for users.

I'm a maintainer for vcpkg, and here is what the port script looks like. We try to keep the library maintained as close as possible to the original library.

@Tachi107
Copy link
Member

Hi, thanks for your patch! How is installing the library with vcpkg different from installing with plain meson setup build && meson install -C build?

@dennisjenkins75
Copy link
Collaborator

Due to use of epoll(), pistache will only work on Linux. It will not compile nor execute natively for Windows, FreeBSD, Mac OS X, Solaris or any other non-Linux OS.

@Tachi107
Copy link
Member

pistache will only work on Linux

Yes, and the vcpkg port already accounts for this

@dennisjenkins75
Copy link
Collaborator

Cool. However, when skimming the vcpkg, I noticed that the json file points to the (old) wrong project URL (https://github.com/oktal/pistache). https://github.com/microsoft/vcpkg/blob/master/ports/pistache/vcpkg.json. It should be "https://github.com/pistacheio/pistache". Due to some weirdness with my IRL employment, I am prohibited from committing to Microsoft's repo, so someone else should fix this.

@kiplingw
Copy link
Member

pistache will only work on Linux

Yes, and the vcpkg port already accounts for this

But what is the point of adding support for it if it can't be built on Windows?

@codecov-commenter
Copy link

codecov-commenter commented Sep 14, 2022

Codecov Report

Merging #1097 (4e863c8) into master (769e4f4) will decrease coverage by 0.16%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1097      +/-   ##
==========================================
- Coverage   78.47%   78.30%   -0.17%     
==========================================
  Files          53       53              
  Lines        6707     6707              
==========================================
- Hits         5263     5252      -11     
- Misses       1444     1455      +11     
Impacted Files Coverage Δ
include/pistache/transport.h 53.75% <0.00%> (-6.25%) ⬇️
src/common/transport.cc 67.94% <0.00%> (-1.61%) ⬇️
include/pistache/async.h 89.94% <0.00%> (-0.19%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@Tachi107
Copy link
Member

Tachi107 commented Sep 14, 2022 via email

@eli-schwartz
Copy link

I still don't understand the usefulness of installing Pistache using the commands added in this patch; I simply don't know what's the difference between that and meson setup build && meson install -C build

It's no different from providing a fifteen line overview of how to sudo apt install pistache (if one assumed that Debian packaged it), complete with instructions on how to:

  • install Debian, so you can use its package manager to install pistache
  • report an out of date package to Debian

It would probably be a lot more useful to add a repology badge:

[![Packaging status](https://repology.org/badge/vertical-allrepos/pistache.svg)](https://repology.org/project/pistache/versions)

Packaging status

And then people could click there, and click a second time for whatever their favorite package manager is -- oh hey, it looks like it's in conan too. ;) Also some recipe collection for a package manager based on a fork of Bazel, so that's apparently... a thing?

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.

6 participants