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

Greatly speed up doctests by compiling compatible doctests in one file #126245

Merged
merged 48 commits into from
Aug 14, 2024
Merged

Greatly speed up doctests by compiling compatible doctests in one file #126245

merged 48 commits into from
Aug 14, 2024
+1,635 −438

Commits on Aug 13, 2024

  1. Clean up rustdoc make_test function code

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    05fbfde View commit details
    Browse the repository at this point in the history

  2. Add DocTest type

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    5e24437 View commit details
    Browse the repository at this point in the history

  3. Simplify doctest tests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    7d72482 View commit details
    Browse the repository at this point in the history

  4. Split doctests between standalone and mergeable ones

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    39f029a View commit details
    Browse the repository at this point in the history

  5. Split standalone and mergeable doctests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    96051f2 View commit details
    Browse the repository at this point in the history

  6. Split doctests into two categories: mergeable ones and standalone ones

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    6ae3524 View commit details
    Browse the repository at this point in the history

  7. Only merge doctests starting 2024 edition

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    58cd70e View commit details
    Browse the repository at this point in the history

  8. Add new doc codeblock standalone attribute

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    3147520 View commit details
    Browse the repository at this point in the history

  9. Add documentation for the doctest standalone attribute

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    23badff View commit details
    Browse the repository at this point in the history

  10. Prevent merged doctests to break stdin if the generated file is too big

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    b7079c5 View commit details
    Browse the repository at this point in the history

  11. If there is any AST error with a doctest, we make it a standalone test 

    To do so, AST error detection was improved in order to not filter out
too many doctests.
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    a0ae8ac View commit details
    Browse the repository at this point in the history

  12. Correctly handle the case where there is no doctests to run

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    59a9e09 View commit details
    Browse the repository at this point in the history

  13. Correctly handle doctests with invalid AST

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    7ec3cab View commit details
    Browse the repository at this point in the history

  14. Add/update rustdoc-ui tests to check new merged doctests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    2fd8d1c View commit details
    Browse the repository at this point in the history

  15. Add new run-make tests for doctests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    010731d View commit details
    Browse the repository at this point in the history

  16. Simplify has_main_fn to be a boolean instead of a Option<Span>

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    03118fa View commit details
    Browse the repository at this point in the history

  17. Greatly improve handling of doctests attributes, making it possible t… 

    …o merge doctests more efficiently
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    6eabffb View commit details
    Browse the repository at this point in the history

  18. Don't merge doctests with #[global_allocator]

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    b6831bb View commit details
    Browse the repository at this point in the history

  19. Fix weird memory allocation failure in merged doctests by storing doc… 

    …test list into a const
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    dcc77b4 View commit details
    Browse the repository at this point in the history

  20. Make merged doctests run in their own process

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    0f0681e View commit details
    Browse the repository at this point in the history

  21. Don't change indent in merged doctests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    995858e View commit details
    Browse the repository at this point in the history

  22. Mark location doctest as standalone since file information will not w… 

    …ork in merged doctest file
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    475824d View commit details
    Browse the repository at this point in the history

  23. Correctly handle internal_features attribute

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    ec4d910 View commit details
    Browse the repository at this point in the history

  24. If no argument is provided to merged doctests binary, they will be ru… 

    …n in the same process (needed for miri)
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    c5ae545 View commit details
    Browse the repository at this point in the history

  25. Only show rustdoc doctest compilation output if nocapture is used

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    0bd2c99 View commit details
    Browse the repository at this point in the history

  26. Disable merged doctests by default

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    112e447 View commit details
    Browse the repository at this point in the history

  27. Correctly handle macros using $crate in merged doctests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    14f80f9 View commit details
    Browse the repository at this point in the history

  28. Add 2024 edition doctests to cover corner cases

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    84d9b67 View commit details
    Browse the repository at this point in the history

  29. Improve code by removing unneeded function arguments

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    6d552ba View commit details
    Browse the repository at this point in the history

  30. Add documentation on DocTest and RunnableDoctest structs

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    bfabf1d View commit details
    Browse the repository at this point in the history

  31. Run mergeable doctest as part of standalone doctests if there is only… 

    … one
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    d512438 View commit details
    Browse the repository at this point in the history

  32. Reduce merged doctest source code size

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    1e1743a View commit details
    Browse the repository at this point in the history

  33. Rename DocTest into DocTestBuilder

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    ffc18c5 View commit details
    Browse the repository at this point in the history

  34. If there are crate attributes, we prevent doctest to be merged with o… 

    …thers
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    0fbc32c View commit details
    Browse the repository at this point in the history

  35. Improve code readability

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    a3bc2c7 View commit details
    Browse the repository at this point in the history

  36. Remove need for unsafe code in merged doctests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    72aeffa View commit details
    Browse the repository at this point in the history

  37. Don't special-case if there is only one merged doctest

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    4b1db07 View commit details
    Browse the repository at this point in the history

  38. Unify naming of DocTest

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    ab3d90e View commit details
    Browse the repository at this point in the history

  39. Move is_multiple_tests argument into RunnableDocTest

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    baf8ce8 View commit details
    Browse the repository at this point in the history

  40. Improve documentation for internal doctest API

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    c9f730e View commit details
    Browse the repository at this point in the history

  41. Add more merged doctests tests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    cbf6fe0 View commit details
    Browse the repository at this point in the history

  42. Add doctest to ensure that doctests with crate-level attributes are n… 

    …ot part of merged doctest
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    7dcb841 View commit details
    Browse the repository at this point in the history

  43. Only keep "useful" code in tests/rustdoc-ui/2024-doctests-checks.rs

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    903d2db View commit details
    Browse the repository at this point in the history

  44. Fix commands syntax in rustdoc-ui tests

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    a708d0b View commit details
    Browse the repository at this point in the history

  45. Run fmt

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    f1c1c49 View commit details
    Browse the repository at this point in the history

  46. Update tests/run-make/doctests-keep-binaries-2024/rmake.rs test to … 

    …new run-make API
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    488614d View commit details
    Browse the repository at this point in the history

  47. Ignore cross compile check for `tests/run-make/doctests-keep-binaries… 

    …-2024` test
    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    1d75f78 View commit details
    Browse the repository at this point in the history

  48. Fix intra-doc link

    @GuillaumeGomez
    GuillaumeGomez committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    05fb8ff View commit details
    Browse the repository at this point in the history