Skip to content

Commit

Permalink
lib: Fix broken link to Cross.toml.
Browse files Browse the repository at this point in the history
  • Loading branch information
har7an committed Feb 20, 2024
1 parent ecbf39a commit f8af44b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -899,7 +899,7 @@ macro_rules! commit_info {
};
}

/// Obtains the [`CrossToml`] from one of the possible locations
/// Obtains the [`CrossToml`][1] from one of the possible locations
///
/// These locations are checked in the following order:
/// 1. If the `CROSS_CONFIG` variable is set, it tries to read the config from its value
Expand All @@ -908,6 +908,8 @@ macro_rules! commit_info {
///
/// The values from `CROSS_CONFIG` or `Cross.toml` are concatenated with the
/// metadata in `Cargo.toml`, with `Cross.toml` having the highest priority.
///
/// [1]: https://github.com/har7an/cross/blob/docs/restructure-docs-folder/docs/config_file.md
pub fn toml(metadata: &CargoMetadata, msg_info: &mut MessageInfo) -> Result<CrossToml> {
let root = &metadata.workspace_root;
let cross_config_path = match env::var("CROSS_CONFIG") {
Expand Down

0 comments on commit f8af44b

Please sign in to comment.