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

Various doc updates #7733

Merged
merged 28 commits into from
Dec 22, 2019
Merged

Various doc updates #7733

merged 28 commits into from
Dec 22, 2019

Commits on Dec 18, 2019

  1. Mention --offline in the FAQ entry on offline.

    @ehuss
    ehuss committed Dec 18, 2019
    Configuration menu
    Copy the full SHA
    4661c9a View commit details
    Browse the repository at this point in the history

  2. Mention that --features can be specified multiple times.

    @ehuss
    ehuss committed Dec 18, 2019
    Configuration menu
    Copy the full SHA
    bb3f132 View commit details
    Browse the repository at this point in the history

  3. Add links for rustflags/rustdocflags.

    @ehuss
    ehuss committed Dec 18, 2019
    Configuration menu
    Copy the full SHA
    97b833e View commit details
    Browse the repository at this point in the history

  4. Document the target directory layout. 

    Closes rust-lang#4756.
    @ehuss
    ehuss committed Dec 18, 2019
    Configuration menu
    Copy the full SHA
    64f605b View commit details
    Browse the repository at this point in the history

  5. Fix awkward comma in sentence.

    @ehuss
    ehuss committed Dec 18, 2019
    Configuration menu
    Copy the full SHA
    98752b0 View commit details
    Browse the repository at this point in the history

  6. Simplify some crates.io links.

    @ehuss
    ehuss committed Dec 18, 2019
    Configuration menu
    Copy the full SHA
    da881b7 View commit details
    Browse the repository at this point in the history

Commits on Dec 19, 2019

  1. Be clearer about which fields are optional/required. 

    This attempts to be clearer about the requirements for crates.io publishing.

This also includes some other clarifications around various fields and specifying dependencies.

Closes rust-lang#3971
Closes rust-lang#7055
    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    2a4aa42 View commit details
    Browse the repository at this point in the history

  2. Fix minor vendor mistake in glossary.

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    b884b0d View commit details
    Browse the repository at this point in the history

  3. Fix some chapter links missing from index pages.

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    07aed50 View commit details
    Browse the repository at this point in the history

  4. Clarify cargo fix behavior with features.

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    fee34fc View commit details
    Browse the repository at this point in the history

  5. Describe dep-info files a little better.

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    765c80d View commit details
    Browse the repository at this point in the history

  6. Mention cargo metadata for custom subcommands.

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    c4033d3 View commit details
    Browse the repository at this point in the history

  7. Build script change detection: link to include/exclude

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    14f7a91 View commit details
    Browse the repository at this point in the history

  8. Break up the Platform specific dependencies section.

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    82bcbde View commit details
    Browse the repository at this point in the history

  9. Show example for 'cfg(feature="foo")' dependency alternative.

    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    18e02da View commit details
    Browse the repository at this point in the history

  10. Try to make it a little clearer that cargo package/publish will rebui… 

    …ld from scratch.

Closes rust-lang#3062
    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    caf88f5 View commit details
    Browse the repository at this point in the history

  11. Try to be clearer about how --target is different. 

    Closes rust-lang#3817
    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    47a46ae View commit details
    Browse the repository at this point in the history

  12. Clarify that [replace] requires a version number. 

    Closes rust-lang#4212
    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    e958fe6 View commit details
    Browse the repository at this point in the history

  13. Document that [replace] should not be used. 

    cc rust-lang#7092
    @ehuss
    ehuss committed Dec 19, 2019
    Configuration menu
    Copy the full SHA
    018b5f5 View commit details
    Browse the repository at this point in the history

Commits on Dec 20, 2019

  1. Try to clarify dev/test profile selection. 

    Closes rust-lang#4438
    @ehuss
    ehuss committed Dec 20, 2019
    Configuration menu
    Copy the full SHA
    e5bc8cc View commit details
    Browse the repository at this point in the history

  2. Don't describe the package layout twice.

    @ehuss
    ehuss committed Dec 20, 2019
    Configuration menu
    Copy the full SHA
    0a5f54b View commit details
    Browse the repository at this point in the history

Commits on Dec 21, 2019

  1. Move cargo targets to a new chapter. 

    Closes rust-lang#6913.
    @ehuss
    ehuss committed Dec 21, 2019
    Configuration menu
    Copy the full SHA
    0f99322 View commit details
    Browse the repository at this point in the history

  2. Move workspaces to a separate chapter.

    @ehuss
    ehuss committed Dec 21, 2019
    Configuration menu
    Copy the full SHA
    f453bed View commit details
    Browse the repository at this point in the history

  3. Move features to a separate chapter.

    @ehuss
    ehuss committed Dec 21, 2019
    Configuration menu
    Copy the full SHA
    dc81356 View commit details
    Browse the repository at this point in the history

  4. Add a table of contents for the manifest. 

    Closes rust-lang#5822
    @ehuss
    ehuss committed Dec 21, 2019
    Configuration menu
    Copy the full SHA
    543e381 View commit details
    Browse the repository at this point in the history

Commits on Dec 22, 2019

  1. Move overriding dependencies into a separate chapter.

    @ehuss
    ehuss committed Dec 22, 2019
    Configuration menu
    Copy the full SHA
    d1d0837 View commit details
    Browse the repository at this point in the history

  2. Add build script examples to reference index.

    @ehuss
    ehuss committed Dec 22, 2019
    Configuration menu
    Copy the full SHA
    c2ff762 View commit details
    Browse the repository at this point in the history

  3. Note that harness=false enables cfg(test).

    @ehuss
    ehuss committed Dec 22, 2019
    Configuration menu
    Copy the full SHA
    493eb34 View commit details
    Browse the repository at this point in the history