Skip to content

Commit 13d92c6

Browse files
committed
Auto merge of #4033 - integer32llc:fix-sys-docs, r=alexcrichton
Clear up Linking to Systems Libraries docs Fixes #2191.
2 parents d8fa3eb + f8414e9 commit 13d92c6

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

src/doc/build-script.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ crate is built:
8282
of the directory itself (which corresponds to some types of changes within the
8383
directory, depending on platform) will trigger a rebuild. To request a re-run
8484
on any changes within an entire directory, print a line for the directory and
85-
another line for everything inside it, recursively.)
85+
another line for everything inside it, recursively.)
8686
Note that if the build script itself (or one of its dependencies) changes,
8787
then it's rebuilt and rerun unconditionally, so
8888
`cargo:rerun-if-changed=build.rs` is almost always redundant (unless you
@@ -427,7 +427,7 @@ script is again to farm out as much of this as possible to make this as easy as
427427
possible for consumers.
428428

429429
As an example to follow, let’s take a look at one of [Cargo’s own
430-
dependencies][git2-rs], [libgit2][libgit2]. This library has a number of
430+
dependencies][git2-rs], [libgit2][libgit2]. The C library has a number of
431431
constraints:
432432

433433
[git2-rs]: https://github.com/alexcrichton/git2-rs/tree/master/libgit2-sys
@@ -441,7 +441,7 @@ constraints:
441441
* It can be built from source using `cmake`.
442442

443443
To visualize what’s going on here, let’s take a look at the manifest for the
444-
relevant Cargo package.
444+
relevant Cargo package that links to the native C library.
445445

446446
```toml
447447
[package]
@@ -464,11 +464,12 @@ As the above manifests show, we’ve got a `build` script specified, but it’s
464464
worth noting that this example has a `links` entry which indicates that the
465465
crate (`libgit2-sys`) links to the `git2` native library.
466466

467-
Here we also see the unconditional dependency on `libssh2` via the
468-
`libssh2-sys` crate, as well as a platform-specific dependency on `openssl-sys`
469-
for \*nix (other variants elided for now). It may seem a little counterintuitive
470-
to express *C dependencies* in the *Cargo manifest*, but this is actually using
471-
one of Cargo’s conventions in this space.
467+
Here we also see that we chose to have the Rust crate have an unconditional
468+
dependency on `libssh2` via the `libssh2-sys` crate, as well as a
469+
platform-specific dependency on `openssl-sys` for \*nix (other variants elided
470+
for now). It may seem a little counterintuitive to express *C dependencies* in
471+
the *Cargo manifest*, but this is actually using one of Cargo’s conventions in
472+
this space.
472473

473474
## `*-sys` Packages
474475

0 commit comments

Comments
 (0)