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

Update documentation to reference 'config.toml' instead of 'config'. #7323

Closed
zachlute opened this issue Sep 3, 2019 · 6 comments
Closed

Update documentation to reference 'config.toml' instead of 'config'. #7323

zachlute opened this issue Sep 3, 2019 · 6 comments
Labels
A-configuration Area: cargo config files and env vars A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` E-easy Experience: Easy

Comments

@zachlute
Copy link
Contributor

zachlute commented Sep 3, 2019

Describe the problem you are trying to solve
After #7273, we now support loading 'config.toml' and 'credentials.toml' in place of the same files without extension, which used to be the default. Files with extensions are easier for people to edit due to syntax highlighting, etc.

Describe the solution you'd like
We should update all Cargo documentation to mention 'config.toml' and 'credentials.toml' so people use those by default instead of the versions without extension.
@zachlute zachlute added the C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` label Sep 3, 2019
@zachlute zachlute mentioned this issue Sep 3, 2019
Merged
@ehuss ehuss added A-configuration Area: cargo config files and env vars A-documenting-cargo-itself Area: Cargo's documentation labels Sep 21, 2019
@alexcrichton
Copy link
Member

I think I got my 6-month-ish ping on this, where now is likely a good time we can start rewriting documentation to reference config.toml instead of config!

@huangjiahua
Copy link
Contributor

Does this mean changing config in text like this

### Hierarchical structure

Cargo allows local configuration for a particular package as well as global
configuration. It looks for configuration files in the current directory and
all parent directories. If, for example, Cargo were invoked in
`/projects/foo/bar/baz`, then the following configuration files would be
probed for and unified in this order:

* `/projects/foo/bar/baz/.cargo/config`
* `/projects/foo/bar/.cargo/config`
* `/projects/foo/.cargo/config`
* `/projects/.cargo/config`
* `/.cargo/config`

into config.toml?
I can help with this.

@alexcrichton
Copy link
Member

Indeed yeah that'd be a great start! I suspect there are more mentions of .cargo/config in the documentation, but updating them incrementally is ok too!

@huangjiahua huangjiahua mentioned this issue Apr 16, 2020
Merged
bors added a commit that referenced this issue Apr 16, 2020
@bors
Auto merge of #8121 - huangjiahua:update-documentation, r=alexcrichton
f9047dc 
Update documentation to mention "config.toml" instead of "config"

I searched for the reference of `config` and `credentials` in `src/doc` and changed to `config.toml` and `credentials.toml` accroding to the context.

#7323
@pickfire
Copy link
Contributor

@huangjiahua I believed this issue is already fixed?

@huangjiahua
Copy link
Contributor

@pickfire Yeah, I think so.

@alexcrichton
Copy link
Member

Oops, thanks for the ping!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-configuration Area: cargo config files and env vars A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` E-easy Experience: Easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@ehuss @alexcrichton @zachlute @pickfire @huangjiahua