clean up rust.md docs #35587

vitiral · 2018-02-25T22:30:04Z

Motivation for this change

I am a NixOS newbie and had a bit of difficulty getting rust setup on my box because I did not have the GNU build dependencies installed.

Things done

Added docs when setting up a rust environment.
Fixed incorrect nix-build command after setting up with carnix
Fits CONTRIBUTING.md although I did not open an issue for a small documentation change

vitiral · 2018-02-25T22:53:57Z

I tested on the following environment:

 - system: `"x86_64-linux"`                                                                                                                                                                                       
 - host os: `Linux 4.14.20, NixOS, 18.03pre129076.831ef4756e3 (Impala)`                                                                                                                                           
 - multi-user?: `yes`                                                                                                                                                                                             
 - sandbox: `no`                                                                                                                                                                                                  
 - version: `nix-env (Nix) 1.11.16`                                                                                                                                                                               
 - channels(root): `"nixos-18.03pre129076.831ef4756e3"`                                                                                                                                                           
 - nixpkgs: `/nix/var/nix/profiles/per-user/root/channels/nixos/nixpkgs`

I am on unstable, but I don't believe carnix is even on the 17.09 stable channel.

vitiral · 2018-03-08T23:03:17Z

I added a fix for #36542 as well, as nix-shell is a pretty standard need for developers.

jtojnar · 2018-03-08T23:38:01Z

doc/languages-frameworks/rust.md

@@ -261,6 +264,46 @@ general. A number of other parameters can be overridden:
  };
  ```

+### Setting Up `nix-env`


Did you mean nix-shell?

thanks for catching that.

jtojnar · 2018-03-09T00:36:52Z

doc/languages-frameworks/rust.md

+      ];
+
+      # Set Relevant ENV Variables
+      LIBRARY_PATH = "${xorg.libX11}/lib:${xorg.libXtst}/lib";


This should not be necessary.

wow, you're right -- it's not. I just did a cargo clean+build without it and it worked

vitiral · 2018-03-09T22:56:33Z

@jtojnar thanks for the review, should be good to go now

jtojnar · 2018-03-09T22:57:51Z

doc/languages-frameworks/rust.md

+      ];
+
+      # Set Relevant ENV Variables
+      PKG_CONFIG_PATH = "${openssl}/lib/pkgconfig";


And neither should this.

I'm frankly shocked. I arrived at the need of environment variables through a highly technical process of trial and error (/sarcasm). I swear this didn't work before... but now it totally does.

So... I would like to have some environment variable example. I'm going to do RUST_BACKTRACE since that is a nice to have.

vitiral · 2018-03-09T23:15:11Z

okay, should be good now :)

vitiral · 2018-03-09T23:59:18Z

okay, so for anyone reading this (and maybe a future PR), to install things like cargo install cargo-edit (which has a dependency on openssl) when using plain NixOS itself I had to do:

  environment.variables = {
    PKG_CONFIG_PATH = [
      "${pkgs.openssl.dev}/lib/pkgconfig"
    ];
  };

Note: this has the effect of inserting the custom ones onto the default $PKG_CONFIG_PATH.

I think I just got confused between nix-shell and plain NixOS

vitiral · 2018-03-27T16:15:58Z

@jtojnar ping, just wondering what else is necessary to move this along.

jtojnar · 2018-03-27T16:31:00Z

@vitiral A go-ahead from someone who maintains Rust in nixpkgs would be great.

vitiral · 2018-03-27T16:44:41Z

From a cursory glance at PR's it looks like @P-E-Meunier and @dywedir might be good candidates for review?

Can one of you guys take a look? Thanks!

globin

LGTM except for the typo

globin · 2018-03-27T18:45:57Z

doc/languages-frameworks/rust.md

@@ -261,6 +264,43 @@ general. A number of other parameters can be overridden:
  };
  ```

+### Setting Up `nix-shell`
+Oftentimes you want to develop code using `nix-env`. Using the example above,


nix-env -> nix-shell?

stale, ack'd in the meantime

- Add example for setting up nix-shell, improve rust docs - Rust docs: add gcc rust dependencies and fix carnix commands - Fix a typo with the carnix command.

vitiral · 2018-03-27T19:26:42Z

rebased, squashed and fixed review comment

vitiral · 2018-03-27T19:28:04Z

@globin thanks!

P-E-Meunier · 2018-03-27T20:00:39Z

doc/languages-frameworks/rust.section.md

@@ -16,6 +16,9 @@ cargo
 into the `environment.systemPackages` or bring them into
 scope with `nix-shell -p rustc cargo`.

+> You may also want the following for building crates with C dependencies:
+> `binutils gcc gnumake`


I think gcc and binutils are always included in the buildInputs in a nix expressions, so this isn't actually necessary. Do you know an example of a crate that requires make (gnumake)?

when I first started using NixOS I couldn't build hardly anything (edit: with C dependencies). Adding these to my configuration.nix allowed me to build things.

I'm not 100% sure gnumake is required but I included it anyway. Can totally remove.

I'll note that they should add these to environment.systemPackages in configuration.nix.

P-E-Meunier · 2018-03-27T20:07:49Z

doc/languages-frameworks/rust.section.md

+```
+
+Crates that have the above dependencies will still compile.
+


That's indeed a very good point to add to the documentation.

However, this is not what I usually do. Your code here would compile crate hello and put its binaries in the scope of the shell. I wonder why you would do that.

If it helps, my usual default.nix uses the builds from rustup (mostly because they're more current), even though this doesn't work on MacOS:

with import <nixpkgs> {}; let src = fetchFromGitHub { owner = "mozilla"; repo = "nixpkgs-mozilla"; rev = "42a0926f2f36cac2da53782259948ba071b6c6c5"; sha256 = "1r2jglgl9k881byv1kc3rdda2lzaarvb0xn7nx3q0b3h25apjff5"; }; in with import "${src.out}/rust-overlay.nix" pkgs pkgs; stdenv.mkDerivation { name = "rust-env"; buildInputs = [ rustChannels.stable.rust ]; }

Another option (MacOS-compatible, but you won't get the nightly builds) is simply:

with import <nixpkgs> {}; stdenv.mkDerivation { name = "rust-env"; buildInputs = [ rust ]; }

So I think there is some confusion here...

I wanted a default.nix which can build the package (generated from carnix) and simultaneously allows me to use nix-shell. I don't think what you posted solves that problem, right?

Right, sorry about that. I usually have a default.nix and a shell.nix, but what you wrote is another solution.
Have you tested though, that RUST_BACKTRACE is actually set in the resulting shell? I don't remember that any variable besides the standard ones is inherited in this way, feel free to update build-rust-crate.nix if not.

Hmm... it doesn't seem to work. I swear I tested it -- but I was also simultaneously testing configuration.nix. I probably set it there and didn't use --pure and got confused :(

I think this all goes back to the core point: I should use stdenv.mkDerivation instead for shell right? I will get right on that :)

Yes, there is a test phase in standard derivations, but I've not implemented that yet in build-rust-crate.nix. I suppose I could work on that some day, but not right now. Meanwhile, you could try to add something in build-rust-crate.nix to inherit all extra variables one might set in an overrideCrate, such as RUST_BACKTRACE.

Okay, I think I will just rework the docs noting that those things are not yet supported for nix-shell and how to use stdenv.mkDerivation instead.

nix-shell still seems magical to me -- how does it know what things are "setup time" vs "build time" (rhetorical)? Other newbies will probably have similar questions, so I think it is a good place to admit our faults :)

Ok, I didn't remember this was an issue, so PLEASE add it to the current documentation: a derivation has phases, documented in https://nixos.org/nixpkgs/manual/#sec-stdenv-phases.

Nix-build sets up the environment by downloading all the buildInputs/propagatedBuildInputs, and then runs all the phases, while nix-shell only sets up the environment.

sounds good. I will reference the issue I just opened: #37945

Note: your example of buildInputs = [ rust ] gives me this:

error: cannot coerce a set to a string, at /nix/store/y68vv1sxb24yykccac566v4xqklnzfa2-nixos-18.03pre130932.cc4677c36ee/nixos/pkgs/stdenv/generic/make-derivation.nix:148:11 (use '--show-trace' to show detailed location information)

changing to rustc cargo works.

P-E-Meunier · 2018-03-27T20:12:16Z

Hi! Any documentation effort on NixOS needs to be welcomed with the highest honours! So first of all, thanks a lot! I'm glad this part of the documentation is finally being tested by new users.

I'd like to see my comments above addressed, I'm willing to review them again as soon as I can.

P-E-Meunier · 2018-03-27T20:14:16Z

Question for @edolstra @Mic92 @grahamc: couldn't we have a bot to choose reviewers automatically and speed this up? This is especially important for documentation.

vitiral · 2018-03-27T22:33:01Z

@P-E-Meunier okay, I did a bit of a refactor trying to distill your feedback. Let me know if there is anything else!

Mic92 · 2018-03-28T01:01:29Z

@P-E-Meunier for package reviews that would not work. Because not everybody has time every day. Only because a bot pings me would not make me merge things faster. Pinging maintainers of packages is something which will be added to borg in near future I think.
For documentation the situation is unfortunate.

- Add example for setting up nix-shell, improve rust docs - Rust docs: add gcc rust dependencies and fix carnix commands - Fix a typo with the carnix command. (cherry picked from commit f7342a3)

Mic92 · 2018-03-28T01:08:35Z

also ported to 18.03: 54c76d5

P-E-Meunier · 2018-03-28T05:41:28Z

@Mic92 : indeed, I'm not sure I want a bot that pings nixpkgs maintainers, but on this particular PR I'd have liked to be pinged earlier, rather than manually by the author.

GrahamcOfBorg added 6.topic: rust 8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels Feb 25, 2018

vitiral force-pushed the rust-depends branch from cc0b8b3 to 3fcd8ee Compare February 25, 2018 22:51

vitiral changed the title ~~add common gcc rust dependencies~~ add common gcc rust dependencies and fix carnix command Feb 25, 2018

vitiral force-pushed the rust-depends branch from 3fcd8ee to 24b574f Compare February 25, 2018 22:54

vitiral mentioned this pull request Feb 26, 2018

rust: nix-build from carnix is not creating binary #35593

Closed

vitiral force-pushed the rust-depends branch from 24b574f to 1911a47 Compare March 8, 2018 23:02

vitiral changed the title ~~add common gcc rust dependencies and fix carnix command~~ clean up rust.md docs Mar 8, 2018

jtojnar previously requested changes Mar 9, 2018

View reviewed changes

vitiral force-pushed the rust-depends branch from 78d6e74 to 5ffdfe2 Compare March 9, 2018 22:54

jtojnar reviewed Mar 9, 2018

View reviewed changes

globin approved these changes Mar 27, 2018

View reviewed changes

fix NixOS#36542 and help newbies to NixOS get setup with rust quicker

fd99070

- Add example for setting up nix-shell, improve rust docs - Rust docs: add gcc rust dependencies and fix carnix commands - Fix a typo with the carnix command.

vitiral force-pushed the rust-depends branch from e75b02a to fd99070 Compare March 27, 2018 19:26

GrahamcOfBorg removed the 6.topic: rust label Mar 27, 2018

P-E-Meunier reviewed Mar 27, 2018

View reviewed changes

vitiral mentioned this pull request Mar 27, 2018

buildRustCrate should support nix-shell features #37945

Open

address review comments

381cb6b

vitiral force-pushed the rust-depends branch from fced6e8 to 381cb6b Compare March 27, 2018 22:25

Mic92 merged commit f7342a3 into NixOS:master Mar 28, 2018

Ekleog mentioned this pull request Oct 29, 2018

question(newbie): how do I set an environment variable in nix-shell for rust packages? #36542

Closed

Janik-Haag added the 12. first-time contribution label Jun 12, 2023

		```

		Crates that have the above dependencies will still compile.

clean up rust.md docs #35587

clean up rust.md docs #35587

Conversation

vitiral commented Feb 25, 2018 • edited

Motivation for this change

Things done

vitiral commented Feb 25, 2018

vitiral commented Mar 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vitiral commented Mar 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vitiral commented Mar 9, 2018

vitiral commented Mar 9, 2018 • edited

vitiral commented Mar 27, 2018

jtojnar commented Mar 27, 2018 • edited

vitiral commented Mar 27, 2018

globin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vitiral commented Mar 27, 2018

vitiral commented Mar 27, 2018

Choose a reason for hiding this comment

vitiral Mar 27, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vitiral Mar 27, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

P-E-Meunier commented Mar 27, 2018

P-E-Meunier commented Mar 27, 2018

vitiral commented Mar 27, 2018

Mic92 commented Mar 28, 2018 • edited

Mic92 commented Mar 28, 2018

P-E-Meunier commented Mar 28, 2018

vitiral commented Feb 25, 2018 •

edited

vitiral commented Mar 9, 2018 •

edited

jtojnar commented Mar 27, 2018 •

edited

vitiral Mar 27, 2018 •

edited

vitiral Mar 27, 2018 •

edited

Mic92 commented Mar 28, 2018 •

edited