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.

Sign up for GitHub

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

Jump to bottom

Add rust-toolchain.toml to project #249

Merged
merged 2 commits into from
May 13, 2021
Merged

Add rust-toolchain.toml to project #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c1973e
Add rust-toolchain.toml to project
markmandel May 12, 2021
ca223af
Merge branch 'main' into tools/rust-toolchain
markmandel May 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ git submodule update --init --recursive
You will likely want to replace `https://github.com/googleforgames/quilkin.git` with your own fork of the repository
for your development.

### Rust version

We target a specific version of Rust for each build, so we can be deliberate when changing versions to
track if there are any performance changes between Rust releases.

Run `rustup show` in the root of the project directory to install the rust toolchain that is standard for Quilkin
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please let me know if there is a better way to do this -- documentation wasn't very clear, and this was the only way that worked for me.

Copy link
Collaborator

@XAMPPRocky XAMPPRocky May 12, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well it might not be clear, because it should be automatic. If you run cargo build or any other tool in the directory and don’t have the toolchain it should automatically download.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what I expected, but when I ran cargo build this didn't seem to work for me. 🤔 This was the only command that I found that effectively adhered to the right tooling.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just tried it - and of course cargo commands just work now 🤦🏻

development.

### Building

Debug release:
Expand Down
17 changes: 17 additions & 0 deletions rust-toolchain.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Copyright 2021 Google LLC All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

[toolchain]
channel = "1.47.0"
components = ["rustfmt", "clippy"]