Skip to content

Commit ce455cd

Browse files
committed
Auto merge of #5600 - jrvidal:sys-packages, r=alexcrichton
Clarify wording around `*-sys` packages I am slightly confused by the wording about `*-sys` packages in the documentation. From what I could gather, Cargo does _not_ treat `foo-sys` in any special way, it's merely a convention _of the crates.io ecosystem_. I've changed that, and also toned down the various "will do this" to "should do this", since nothing is actually _enforcing_ these conventions. I am not a native speaker, so I might have read the whole thing wrong. 🤷‍♀️
2 parents 5845464 + e255418 commit ce455cd

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/doc/src/reference/build-scripts.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -509,15 +509,15 @@ this space.
509509

510510
### `*-sys` Packages
511511

512-
To alleviate linking to system libraries, Cargo has a *convention* of package
513-
naming and functionality. Any package named `foo-sys` will provide two major
512+
To alleviate linking to system libraries, crates.io has a *convention* of package
513+
naming and functionality. Any package named `foo-sys` should provide two major
514514
pieces of functionality:
515515

516-
* The library crate will link to the native library `libfoo`. This will often
516+
* The library crate should link to the native library `libfoo`. This will often
517517
probe the current system for `libfoo` before resorting to building from
518518
source.
519-
* The library crate will provide **declarations** for functions in `libfoo`,
520-
but it does **not** provide bindings or higher-level abstractions.
519+
* The library crate should provide **declarations** for functions in `libfoo`,
520+
but **not** bindings or higher-level abstractions.
521521

522522
The set of `*-sys` packages provides a common set of dependencies for linking
523523
to native libraries. There are a number of benefits earned from having this

0 commit comments

Comments
 (0)