Skip to content

Commit

Permalink
Prepare PR #329 to be merged
Browse files Browse the repository at this point in the history
We made an editorial pass over this.
  • Loading branch information
traviscross committed Oct 30, 2024
1 parent d7a41be commit 96ea984
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 65 deletions.
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@
- [Unsafe `extern` blocks](rust-2024/unsafe-extern.md)
- [Unsafe attributes](rust-2024/unsafe-attributes.md)
- [Rustdoc combined tests](rust-2024/rustdoc-doctests.md)
- [Rustdoc nested `include!` change](rust-2024/rustdoc-nested-includes.md)
- [Reserved syntax](rust-2024/reserved-syntax.md)
- [Rustdoc doctest nested `include_str!` change](rust-2024/rustdoc-doctests-nested-include-str.md)
64 changes: 0 additions & 64 deletions src/rust-2024/rustdoc-doctests-nested-include-str.md

This file was deleted.

63 changes: 63 additions & 0 deletions src/rust-2024/rustdoc-nested-includes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Rustdoc nested `include!` change

🚧 The 2024 Edition has not yet been released and hence this section is still "under construction".
More information may be found in the tracking issue at <https://github.com/rust-lang/rust/issues/132230>.

## Summary

When a doctest is included with `include_str!`, if that doctest itself also uses `include!`, `include_str!`, or `include_bytes!`, the path is resolved relative to the Markdown file, rather than to the Rust source file.

## Details

Prior to the 2024 edition, adding documentation with `#[doc=include_str!("path/file.md")]` didn't carry span information into any doctests in that file. As a result, if the Markdown file was in a different directory than the source, any paths included had to be specified relative to the source file.

For example, consider a library crate with these files:

- `Cargo.toml`
- `README.md`
- `src/`
- `lib.rs`
- `examples/`
- `data.bin`

Let's say that `lib.rs` contains this:

```rust,ignore
#![doc=include_str!("../README.md")]
```

And assume this `README.md` file:

````markdown
```
let _ = include_bytes!("../examples/data.bin");
// ^^^ notice this
```
````

Prior to the 2024 edition, the path in `README.md` needed to be relative to the `lib.rs` file. In 2024 and later, it is now relative to `README.md` itself, so we would update `README.md` to:

````markdown
```
let _ = include_bytes!("examples/data.bin");
```
````

## Migration

There is no automatic migration to convert the paths in affected doctests. If one of your doctests is affected, you'll see an error like this after migrating to the new edition when building your tests:

```text
error: couldn't read `../examples/data.bin`: No such file or directory (os error 2)
--> src/../README.md:2:24
|
2 | let _ = include_bytes!("../examples/data.bin");
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
= note: this error originates in the macro `include_bytes` (in Nightly builds, run with -Z macro-backtrace for more info)
help: there is a file with the same name in a different directory
|
2 | let _ = include_bytes!("examples/data.bin");
| ~~~~~~~~~~~~~~~~~~~
```

To migrate your doctests to Rust 2024, update any affected paths to be relative to the file containing the doctests.

0 comments on commit 96ea984

Please sign in to comment.