mirror of https://github.com/rust-lang/cargo
Auto merge of #10494 - ehuss:deps-of-doc, r=Eh2406
Update doc string for deps_of/compute_deps. I noticed the `compute_deps` doc string was outdated due to some recent refactorings. This updates the doc comments to try to clarify them and make them more accurate.
This commit is contained in:
commit
cd46164480
|
@ -226,7 +226,10 @@ fn deps_of_roots(roots: &[Unit], state: &mut State<'_, '_>) -> CargoResult<()> {
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Compute the dependencies of a single unit.
|
/// Compute the dependencies of a single unit, recursively computing all
|
||||||
|
/// transitive dependencies.
|
||||||
|
///
|
||||||
|
/// The result is stored in `state.unit_dependencies`.
|
||||||
fn deps_of(unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor) -> CargoResult<()> {
|
fn deps_of(unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor) -> CargoResult<()> {
|
||||||
// Currently the `unit_dependencies` map does not include `unit_for`. This should
|
// Currently the `unit_dependencies` map does not include `unit_for`. This should
|
||||||
// be safe for now. `TestDependency` only exists to clear the `panic`
|
// be safe for now. `TestDependency` only exists to clear the `panic`
|
||||||
|
@ -246,10 +249,7 @@ fn deps_of(unit: &Unit, state: &mut State<'_, '_>, unit_for: UnitFor) -> CargoRe
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// For a package, returns all targets that are registered as dependencies
|
/// Returns the direct unit dependencies for the given `Unit`.
|
||||||
/// for that package.
|
|
||||||
/// This returns a `Vec` of `(Unit, UnitFor)` pairs. The `UnitFor`
|
|
||||||
/// is the profile type that should be used for dependencies of the unit.
|
|
||||||
fn compute_deps(
|
fn compute_deps(
|
||||||
unit: &Unit,
|
unit: &Unit,
|
||||||
state: &mut State<'_, '_>,
|
state: &mut State<'_, '_>,
|
||||||
|
|
Loading…
Reference in New Issue