rust-openssl / rust-openssl/rust-openssl

Clarify Windows Build Instructions

Open
#1,861 2 comments 10 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.6k
Forks
841
Avg merge
6h 51m
Merged PRs (30d)
4

Description

The "install failed" output on Windows links to a README section which does not exist:

https://github.com/sfackler/rust-openssl/blob/0138f525243e8d2ed2573e86ffaed7178c30b904/openssl-sys/build/find_normal.rs#L179-L184

https://docs.rs/openssl/latest/openssl/ hints that vcpkg is one of the recommended options, and indeed running

vcpkg install --triplet=x64-windows-static-md openssl

does work as expected (although I first had to figure out that I need to supply --triplet).

I'm happy to send a PR to update either error message or add a README section if someone lets me know what would be preferred. :)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting openssl-sys/build/find_normal.rs around lines 179-184 and the repository README to locate the missing Windows guidance. Decide whether the documented vcpkg command belongs in the error message or README, then verify that the resulting instructions cover the required triplet and match the reported working setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.