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

Docs and crate publishing #1

Open
halvnykterist opened this issue Aug 6, 2022 · 11 comments
Open

Docs and crate publishing #1

halvnykterist opened this issue Aug 6, 2022 · 11 comments

Comments

@halvnykterist
Copy link

This is really cool! Is there a reason it hasn't been published as a crate? Having the autogenerated docs readily available would help a lot.

@hussein-aitlahcen
Copy link
Owner

hussein-aitlahcen commented Aug 6, 2022

Hey, thanks! The crate is not compilling right now (it does for me because I already applied some patchs to GNS), I'm waiting for ValveSoftware/GameNetworkingSockets#248 and ValveSoftware/GameNetworkingSockets#251 to land, then setup CI for Windows and Linux build.

@hussein-aitlahcen
Copy link
Owner

@halvnykterist I've decided to use my fork in the meantime, the CI is passing for both windows and linux.
I've also added more rustdoc and will publish the crate.

@hussein-aitlahcen
Copy link
Owner

Unfortunately, crates.io does not support submodules... The maximum upload size is 10mb and the submodule is too big to fit. I am not going to tweak the build.rs to handle this. For the documentation, we'll use github pages for now. The doc is available here

@halvnykterist
Copy link
Author

Shame about the submodules, but the docs are really what's important anyway. Excited to check it out.

@2l47
Copy link

2l47 commented Sep 14, 2022

@hussein-aitlahcen With those PRs being closed, is the crate ready to be published?

@hussein-aitlahcen
Copy link
Owner

hussein-aitlahcen commented Sep 15, 2022

@hussein-aitlahcen With those PRs being closed, is the crate ready to be published?

EDIT: See #1 (comment)

@hussein-aitlahcen
Copy link
Owner

@2l47 sadly the crate can't be published due to the above limitation. If you want to use it you can reference it in cargo using a git dependency.

@halotroop2288
Copy link

in cargo using a git dependency

[dependencies]
gns = { git = "https://github.com/hussein-aitlahcen/gns-rs", branch = "master" }

This results in the error:

error: failed to run custom build command for `gns-sys v0.1.0 (https://github.com/hussein-aitlahcen/gns-rs?branch=master#8daa3561)`

So, I don't think that's going to work.

@hussein-aitlahcen
Copy link
Owner

hussein-aitlahcen commented Jan 17, 2023

in cargo using a git dependency

[dependencies]
gns = { git = "https://github.com/hussein-aitlahcen/gns-rs", branch = "master" }

This results in the error:

error: failed to run custom build command for `gns-sys v0.1.0 (https://github.com/hussein-aitlahcen/gns-rs?branch=master#8daa3561)`

So, I don't think that's going to work.

Hi, could you provide the full trace please ? The lib require clang/protobuf/openssl to build, you can see the env variables setup in the following file

gns-rs/flake.nix

Lines 30 to 35 in 8daa356

PROTOC = "${protobuf}/bin/protoc";
LIBCLANG_PATH = "${llvmPackages.libclang.lib}/lib";
LD_LIBRARY_PATH =
lib.makeLibraryPath [ clangStdenv.cc.cc.lib openssl protobuf ];
CPLUS_INCLUDE_PATH = "${openssl.dev}/include";
};

@halotroop2288
Copy link

Hi, could you provide the full trace please ?

Here it is in a test project, to isolate any other issues.
https://hastebin.com/tehorogovu.less

@hussein-aitlahcen
Copy link
Owner

Hi, could you provide the full trace please ?

Here it is in a test project, to isolate any other issues. https://hastebin.com/tehorogovu.less

Looks like you are missing the protobuf compiler in your path.

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

No branches or pull requests

4 participants