Skip to content

Clarified naming convention for Cargo #26032

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

Merged
merged 4 commits into from
Jun 6, 2015
Merged

Clarified naming convention for Cargo #26032

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f9bfebb
Clarified naming convention for Cargo
achiwhane Jun 5, 2015
629be84
edit for clarity and grammar
achiwhane Jun 5, 2015
455b931
fix typo
achiwhane Jun 5, 2015
ac3301e
fix some errors
achiwhane Jun 5, 2015
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
18 changes: 9 additions & 9 deletions src/doc/trpl/hello-cargo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ $ mv main.rs src/main.rs
```

Note that since we're creating an executable, we used `main.rs`. If we
want to make a library instead, we should use `lib.rs`.
want to make a library instead, we should use `lib.rs`. This convention is required
for Cargo to successfully compile our projects, but it can be overridden if we wish.
Custom file locations for the entry point can be specified
with a [`[[lib]]` or `[[bin]]`][crates-custom] key in the TOML file described below.

Expand Down Expand Up @@ -62,18 +63,17 @@ version = "0.0.1"
authors = [ "Your name <[email protected]>" ]
```

This file is in the [TOML][toml] format. Let’s let it explain itself to you:
This file is in the [TOML][toml] format. TOML is similar to INI, but has some
extra goodies. According to the TOML docs,

> TOML aims to be a minimal configuration file format that's easy to read due
> to obvious semantics. TOML is designed to map unambiguously to a hash table.
> TOML should be easy to parse into data structures in a wide variety of
> languages.

TOML is very similar to INI, but with some extra goodies.

[toml]: https://github.com/toml-lang/toml

Once you have this file in place, we should be ready to build! Try this:
Once you have this file in place, we should be ready to build! To do so, run:

```bash
$ cargo build
Expand All @@ -82,7 +82,7 @@ $ ./target/debug/hello_world
Hello, world!
```

Bam! We build our project with `cargo build`, and run it with
Bam! We built our project with `cargo build`, and ran it with
`./target/debug/hello_world`. We can do both in one step with `cargo run`:

```bash
Expand All @@ -103,9 +103,9 @@ Hello, world!
```

This hasn’t bought us a whole lot over our simple use of `rustc`, but think
about the future: when our project gets more complex, we would need to do more
about the future: when our project gets more complex, we need to do more
things to get all of the parts to properly compile. With Cargo, as our project
grows, we can just `cargo build`, and it’ll work the right way.
grows, we can just run `cargo build`, and it’ll work the right way.

When your project is finally ready for release, you can use
`cargo build --release` to compile your project with optimizations.
Expand All @@ -118,7 +118,7 @@ name = "hello_world"
version = "0.0.1"
```

This file is used by Cargo to keep track of dependencies in your application.
The `Cargo.lock` file is used by Cargo to keep track of dependencies in your application.
Right now, we don’t have any, so it’s a bit sparse. You won't ever need
to touch this file yourself, just let Cargo handle it.

Expand Down