Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustdoc: Implement cross-crate searching #12946

Closed
wants to merge 1 commit into from

Commits on Mar 18, 2014

  1. rustdoc: Implement cross-crate searching

    A major discoverability issue with rustdoc is that all crates have their
    documentation built in isolation, so it's difficult when looking at the
    documentation for libstd to learn that there's a libcollections crate with a
    HashMap in it.
    
    This commit moves rustdoc a little closer to improving the multiple crate
    experience. This unifies all search indexes for all crates into one file so all
    pages share the same search index. This allows searching to work across crates
    in the same documentation directory (as the standard distribution is currently
    built).
    
    This strategy involves updating a shared file amongst many rustdoc processes, so
    I implemented a simple file locking API for handling synchronization for updates
    to the shared files.
    
    cc rust-lang#12554
    alexcrichton committed Mar 18, 2014
    4 Configuration menu
    Copy the full SHA
    7da1d66 View commit details
    Browse the repository at this point in the history