Skip to content

Commit

Permalink
Fixes for esp-config and esp-storage
Browse files Browse the repository at this point in the history
  • Loading branch information
jessebraham committed Jan 24, 2025
1 parent f364f7a commit aa162ea
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions esp-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ This crate is guaranteed to compile when using the latest stable Rust version at

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT)
- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](../LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

Expand Down
13 changes: 7 additions & 6 deletions xtask/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -212,13 +212,14 @@ pub fn build_documentation(
let args = builder.build();
log::debug!("{args:#?}");

let mut envs = vec![("RUSTDOCFLAGS", "--cfg docsrs --cfg not_really_docsrs")];
// Special case: `esp-storage` requires the optimization level to be 2 or 3:
if package == Package::EspStorage {
envs.push(("CARGO_PROFILE_DEBUG_OPT_LEVEL", "3"));
}

// Execute `cargo doc` from the package root:
cargo::run_with_env(
&args,
&package_path,
[("RUSTDOCFLAGS", "--cfg docsrs --cfg not_really_docsrs")],
false,
)?;
cargo::run_with_env(&args, &package_path, envs, false)?;

// Build up the path at which the built documentation can be found:
let mut docs_path = workspace.join(package.to_string()).join("target");
Expand Down

0 comments on commit aa162ea

Please sign in to comment.