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

adds rustfmt instructions to supported dev env #6570

Merged
merged 4 commits into from Jun 10, 2019

Conversation

@nellshamrell
Copy link
Contributor

commented May 16, 2019

Signed-off-by: Nell Shamrell nellshamrell@gmail.com

adds rustfmt instructions to supported dev env
Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>
@chef-expeditor

This comment has been minimized.

Copy link

commented May 16, 2019

Hello nellshamrell! Thanks for the pull request!

Here is what will happen next:

  1. Your PR will be reviewed by the maintainers.
  2. If everything looks good, one of them will approve it, and your PR will be merged.

Thank you for contributing!

BUILDING.md Outdated Show resolved Hide resolved
BUILDING.md Outdated Show resolved Hide resolved
BUILDING.md Outdated Show resolved Hide resolved
adds instructions to find and specify the latest nightly version of r…
…ustfmt

Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>
@nellshamrell

This comment has been minimized.

Copy link
Contributor Author

commented May 17, 2019

@chefsalim and @baumanj - thanks for the feedback. I have combined your suggestions and updated the doc!

```
rustup toolchain install nightly nightly-2019-03-04
rustup component add rustfmt --toolchain nightly-2019-03-04 rustfmt
```

This comment has been minimized.

Copy link
@christophermaier

christophermaier May 20, 2019

Contributor

I think @baumanj's suggestion (#6570 (comment)) was, rather than hard-code a specific nightly version in this example, directly source the contents of the file that we keep updated with the latest nightly version that works.

That way, you can just run that command, and it will get the version we're currently using.

This comment has been minimized.

Copy link
@baumanj

baumanj May 20, 2019

Member

☝️

This comment has been minimized.

Copy link
@baumanj

baumanj Jun 5, 2019

Member

Yeah, I think we should suggest people to just run

cargo +"$(< RUSTFMT_VERSION)" fmt

This comment has been minimized.

Copy link
@nellshamrell

nellshamrell Jun 10, 2019

Author Contributor

Won't that only work at the root level of the Habitat project, though? I tried it from within a component directory and it did not work.

This comment has been minimized.

Copy link
@baumanj

baumanj Jun 10, 2019

Member

This is a command you'd want to run from the root. If run from a component directory, I think the

bash: RUSTFMT_VERSION: No such file or directory

error should be sufficient to let users know what's gone wrong.

This comment has been minimized.

Copy link
@nellshamrell

nellshamrell Jun 10, 2019

Author Contributor

I'd much rather err on the side of clarity and be explicit.

BUILDING.md Outdated Show resolved Hide resolved
update rust format install and usage instructions
Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>
@nellshamrell

This comment has been minimized.

Copy link
Contributor Author

commented Jun 3, 2019

Just updated this based on suggestions!

BUILDING.md Outdated Show resolved Hide resolved
make rustfmt versions consistent
Signed-off-by: Nell Shamrell <nellshamrell@gmail.com>

@nellshamrell nellshamrell merged commit b4c0e3b into master Jun 10, 2019

4 of 5 checks passed

buildkite/habitat-sh-habitat-master-verify Build #2132 passed and blocked (14 seconds)
Details
DCO This commit has a DCO Signed-off-by
Details
buildkite/habitat-sh-habitat-master-website Build #2310 passed and blocked (13 seconds)
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
expeditor/config-validation Validated your Expeditor config file
Details

chef-ci added a commit that referenced this pull request Jun 10, 2019

Update CHANGELOG.md with details from pull request #6570
Obvious fix; these changes are the result of automation not creative thinking.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.