Build even when broken symlinks are present

[maowen]

Better resolution to #1396.

The previous resolution to #1396 (#1399) provides better context when reporting the error but didn't resolve the issue because the mdBok build still fails if there is a broken symlink in the book source tree.

I have need for the mdBook builds to succeed even when broken symlinks are present (e.g. symlinks in source code tree that will be used to create a installable package).

This MR gracefully ignores symlinks that are broken and provides a helpful info! level log message. A unit test was added to verify the new behavior.

[maowen]

Would someone be willing to give me feedback on this PR? This solves a problem that I am having with mdBook and I'd like to get it merged if appropriate.

[ehuss]

I'm concerned about broken symlinks leading to a broken build or broken links. Would something like ignoring those paths (#1908) work for you?

[ehuss]

@rustbot author

[xscottxbrownx]

@maowen

I've run into an issue where I create a valid symlink (or so it seems, as it creates the file in the folder I told it to - shows up in green, meaning it's new - and hovering on it says it is a Symbolic Link)

but when trying to run mdbook serve it errors and has a weird path...

Command shows blue on left, meaning it worked:

New file made, says it's a Symbolic Link:

Try to run mdbook serve and looks like it's trying to use path as if . is a folder:

So, I deleted the symlink with unlink. Then, I attempted the command ln -s ./setup/languages.md miscellaneous/languages/md which resulted in the exact same thing.

Thoughts or ideas?

[rustbot]

☔ The latest upstream changes (possibly #2681) made this pull request unmergeable. Please resolve the merge conflicts.