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

Mergeable rustdoc cross-crate info #3662

Merged
merged 28 commits into from
Sep 21, 2024
Merged

Commits on Jun 19, 2024

  1. Configuration menu
    Copy the full SHA
    542dcbb View commit details
    Browse the repository at this point in the history

Commits on Jun 20, 2024

  1. Configuration menu
    Copy the full SHA
    fdc1b70 View commit details
    Browse the repository at this point in the history
  2. fix typos

    EtomicBomb committed Jun 20, 2024
    Configuration menu
    Copy the full SHA
    8c78a93 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    08ac8a2 View commit details
    Browse the repository at this point in the history
  4. fix typos

    EtomicBomb committed Jun 20, 2024
    Configuration menu
    Copy the full SHA
    ef10ed5 View commit details
    Browse the repository at this point in the history
  5. whitespace and clear lines

    EtomicBomb committed Jun 20, 2024
    Configuration menu
    Copy the full SHA
    4994251 View commit details
    Browse the repository at this point in the history
  6. typo

    EtomicBomb committed Jun 20, 2024
    Configuration menu
    Copy the full SHA
    0f01c9b View commit details
    Browse the repository at this point in the history
  7. remove work in progress

    EtomicBomb committed Jun 20, 2024
    Configuration menu
    Copy the full SHA
    7db0a4a View commit details
    Browse the repository at this point in the history

Commits on Jun 21, 2024

  1. Configuration menu
    Copy the full SHA
    23e34e0 View commit details
    Browse the repository at this point in the history

Commits on Jun 24, 2024

  1. Configuration menu
    Copy the full SHA
    97cf6c6 View commit details
    Browse the repository at this point in the history
  2. typos

    EtomicBomb committed Jun 24, 2024
    Configuration menu
    Copy the full SHA
    3326b10 View commit details
    Browse the repository at this point in the history

Commits on Jun 25, 2024

  1. nits

    EtomicBomb committed Jun 25, 2024
    Configuration menu
    Copy the full SHA
    cbd62bb View commit details
    Browse the repository at this point in the history

Commits on Jun 28, 2024

  1. Configuration menu
    Copy the full SHA
    eba7fc4 View commit details
    Browse the repository at this point in the history

Commits on Jul 16, 2024

  1. Configuration menu
    Copy the full SHA
    7b82ab9 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    63107f9 View commit details
    Browse the repository at this point in the history

Commits on Jul 17, 2024

  1. Configuration menu
    Copy the full SHA
    3d0dd8c View commit details
    Browse the repository at this point in the history

Commits on Jul 18, 2024

  1. Configuration menu
    Copy the full SHA
    0ddbcf6 View commit details
    Browse the repository at this point in the history

Commits on Jul 31, 2024

  1. type impl,buck2 link,extern-html-root-url,period

    fixed broken buck2 link, address notriddle's comment about trait vs type
    impls, adds period at ends of sentence that are missing periods, and
    adds clarification about the usefulness of extern-html-root-url
    EtomicBomb committed Jul 31, 2024
    Configuration menu
    Copy the full SHA
    f639365 View commit details
    Browse the repository at this point in the history
  2. rename flags per camelid, clarify workflow

    * Rename --merge=none|read-write|write-only to --merge=none|shared|finalize
    * --write-info-json=target/doc.parts/my-crate/crate-info.json -> --parts-out-dir=target/doc.parts/my-crate
    * --include-info-json=target/doc.parts/my-crate/crate-info.json -> --include-parts-dir=target/doc.parts/my-crate
    * Clarify the three modes / workflows in the text of the RFC
    EtomicBomb committed Jul 31, 2024
    Configuration menu
    Copy the full SHA
    627a0ba View commit details
    Browse the repository at this point in the history
  3. move extern-html-root-url, remove no_emit_shared

    I moved the section discussing --extern-html-root-url from unresolved
    questions to the Reference-level explanation, as there have been no
    proposals discussing alternatives.
    
    I removed the section about no_emit_shared in unresolved questions,
    because it has not come up in discussion and no_emit_shared was never a
    command line option anyway. The names proposed in discussion are better
    and more declarative suggestions
    EtomicBomb committed Jul 31, 2024
    Configuration menu
    Copy the full SHA
    b0dc37d View commit details
    Browse the repository at this point in the history

Commits on Aug 2, 2024

  1. manishearth nits + stabilize crate-info.json

    * Explain default behavior of rustdoc in Reference-level explanation
    * Flag summary in Guide-level explanation
    * Say that crate-info.json is stable because build systems need to rely
      on it
    * t,s,i -> trait-crate, struct-crate, index-crate
    * T, S -> Trait, Struct
    EtomicBomb committed Aug 2, 2024
    Configuration menu
    Copy the full SHA
    4b076f6 View commit details
    Browse the repository at this point in the history

Commits on Aug 3, 2024

  1. del --include-rendered-docs, doc.parts suggestions

    * Remove the --include-rendered-docs flag
    * --parts-out-dir restricted to --merge=none
    * --include-parts-dir restricted to --merge=finalize
    * crate-info.json -> crate-info to emphasize opaqueness
    * doc.parts contents edition stability promises are
      replaced with a statement saying that
      rustdoc will make an reasonable effort to continue
      just having crate-info files
    EtomicBomb committed Aug 3, 2024
    Configuration menu
    Copy the full SHA
    d7ea3b5 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    628c7a9 View commit details
    Browse the repository at this point in the history

Commits on Aug 13, 2024

  1. editorial changes in response to @jsha

    * New directory: `doc.parts/<crate-name>/crate-info` -> New directory: `doc.parts`.
    * Number of times `--parts-out-dir`, `--merge`, and `--include-parts-dir` can be provided are mentioned.
    * Describe why `doc.parts` is a directory.
    * Description of multiple parallel invocations of rustdoc.
    * Describe why to run rustc before rustdoc.
    * Fix typos.
    EtomicBomb committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    c765097 View commit details
    Browse the repository at this point in the history
  2. resolve in favor of no index crate

    * remove 'Unresolved: index crate?' from the unresolved questions section
    * remove the requirement on the index crate from various sections
    EtomicBomb committed Aug 13, 2024
    Configuration menu
    Copy the full SHA
    ac9208c View commit details
    Browse the repository at this point in the history

Commits on Aug 20, 2024

  1. fix typo identified by jsha

    typo in --merge=finalize description: can links
    EtomicBomb committed Aug 20, 2024
    Configuration menu
    Copy the full SHA
    e66bb63 View commit details
    Browse the repository at this point in the history

Commits on Aug 21, 2024

  1. editorial fixes from @aDotInTheVoid's suggestions

    * full sentences in intro
    * Clarify Cargo's expected use of `--merge=none|shared|finalize`
    * Explain why you would use multiple rustdoc invocations with the same --out-dir
      and merge=none
    * Remove justification for why rustdoc output can be unstable in general
    * Permalink specific fuchsia commit
    EtomicBomb committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    665a58f View commit details
    Browse the repository at this point in the history

Commits on Aug 25, 2024

  1. replace WIP -> implementation, per camelid

    Change sentence reading "The WIP may change the sorting order..." to "The implementation may change the sorting order..."
    
    Co-authored-by: Noah Lev <camelidcamel@gmail.com>
    EtomicBomb and camelid authored Aug 25, 2024
    Configuration menu
    Copy the full SHA
    e1b5e5b View commit details
    Browse the repository at this point in the history