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.

Sign up for GitHub

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

Jump to bottom

rustdoc: Start cleaning up search index generation #92340

Merged
merged 8 commits into from
Dec 29, 2021
Merged

rustdoc: Start cleaning up search index generation #92340

merged 8 commits into from
Dec 29, 2021

Commits on Dec 28, 2021

  1. Rename rustdoc::html::render::cache to search_index 

    The old name wasn't very clear, while the new one makes it clear that
this is the code responsible for creating the search index.
    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    60a1abe View commit details
    Browse the repository at this point in the history

  2. rustdoc: Remove some unnecessary cache parameters 

    Based on
rust-lang#80883 (comment).
The `tcx` parameters do seem to be used though, so I only removed the
`cache` parameters.
    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    e19593f View commit details
    Browse the repository at this point in the history

  3. Move ExternalLocation to clean::types 

    It was previously defined in `render::search_index` but wasn't used at
all there. `clean::types` seems like a better fit since that's where
`ExternalCrate` is defined.
    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    2b801dc View commit details
    Browse the repository at this point in the history

  4. Make search_index functions private where possible 

    Now the only two crate-public items are `build_index` and
`get_index_search_type` (because for some reason the latter is also used
in `formats::cache`).
    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    bd6692c View commit details
    Browse the repository at this point in the history

  5. Coalesce two arguments as &Function

    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    afb77a9 View commit details
    Browse the repository at this point in the history

  6. Give clearer names to several search index functions

    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    5c8e8e5 View commit details
    Browse the repository at this point in the history

  7. Remove unused parameter

    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    7d1ec64 View commit details
    Browse the repository at this point in the history

  8. Add regression test for rust-lang#59502 

    This issue was fixed using a hacky recursion "fuel" argument, but the
issue was never minimized nor was a regression test added. The
underlying bug is still unfixed, so this test should help with fixing it
and removing the `recurse` hack.
    @camelid
    camelid committed Dec 28, 2021
    Configuration menu
    Copy the full SHA
    908a9d4 View commit details
    Browse the repository at this point in the history