itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-28 11:20:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(project-layout): add note on recommended target naming

Browse Source
This commit is contained in:
Dominick Schroer 2024-08-21 15:45:26 -04:00 committed by Dominick Schroer
parent 9e152bba50
commit f8984e1169
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/doc/src/guide/project-layout.md
View File

@ -48,6 +48,8 @@ files, place a `main.rs` file along with the extra [*modules*][def-module]
within a subdirectory of the `src/bin`, `examples`, `benches`, or `tests`
directory. The name of the executable will be the directory name.
> **Note:** By convention, binaries, examples, benches and integration tests follow `kebab-case` naming style, unless there are compatibility reasons to do otherwise (e.g. compatibility with a pre-existing binary name). Modules within those targets are `snake_case` following the [Rust standard](https://rust-lang.github.io/rfcs/0430-finalizing-naming-conventions.html).
You can learn more about Rust's module system in [the book][book-modules].
See [Configuring a target] for more details on manually configuring targets.