rustdoc fails after interrupting doc generation

[TheNeikos]

I tried this command:

cargo doc

I then pressed ctrl-c to stop it. I then re-ran it.

I expected to see this happen: It builds the documentation

Instead, this happened:

error: couldn't generate documentation: invalid template: invalid format: should have a newline on the last line
  |
  = note: failed to create or modify "/home/neikos/projects/software-suite/target/doc/search-index.js"

error: could not document `unicode-ident`
warning: build failed, waiting for other jobs to finish...
error: could not document `smallvec`
error: could not document `thiserror`

Meta

✦ ❯ rustdoc --version --verbose
rustdoc 1.85.0 (4d91de4e4 2025-02-17)
binary: rustdoc
commit-hash: 4d91de4e48198da2e33413efdcd9cd2cc0c46688
commit-date: 2025-02-17
host: x86_64-unknown-linux-gnu
release: 1.85.0
LLVM version: 19.1.7

[lolbinarycat]

It seems like you're interrupting rustdoc while that file is being written.

unlike most build artifacts, the search index is currently persisted across rebuilds.

I believe that cargo doc should remove the search index before invoking rustdoc, as that would also solve #133544

[lolbinarycat]

this would be fixed by mergable cross crate info (#130676)

[ijackson]

It seems likely to me that the bug is simply that rustdoc doesn't perform the update to this file via the standard "write to temporary file, then move in place" approach.

If it did that, then the version of the file under its proper name would never be a partially written one.

[ijackson]

PS: somehow this has started happening to me a lot more often recently. I'm not sure if this is a change to my workspace or to my workflow, or a change in cargo or rustdoc.

[ijackson]

I just had a similar problem happen with a file target/doc/trait.impl/core/marker/trait.Sync.js. Unfortunately I don't have the proper error message, but my shell history tells me that deleting that file fixed the issue.