mirror of
https://github.com/neondatabase/neon.git
synced 2026-01-15 17:32:56 +00:00
982fce1e72
## Problem `cargo +nightly doc` is giving a lot of warnings: broken links, naked URLs, etc. ## Summary of changes * update the `proc-macro2` dependency so that it can compile on latest Rust nightly, see https://github.com/dtolnay/proc-macro2/pull/391 and https://github.com/dtolnay/proc-macro2/issues/398 * allow the `private_intra_doc_links` lint, as linking to something that's private is always more useful than just mentioning it without a link: if the link breaks in the future, at least there is a warning due to that. Also, one might enable [`--document-private-items`](https://doc.rust-lang.org/cargo/commands/cargo-doc.html#documentation-options) in the future and make these links work in general. * fix all the remaining warnings given by `cargo +nightly doc` * make it possible to run `cargo doc` on stable Rust by updating `opentelemetry` and associated crates to version 0.19, pulling in a fix that previously broke `cargo doc` on stable: https://github.com/open-telemetry/opentelemetry-rust/pull/904 * Add `cargo doc` to CI to ensure that it won't get broken in the future. Fixes #2557 ## Future work * Potentially, it might make sense, for development purposes, to publish the generated rustdocs somewhere, like for example [how the rust compiler does it](https://doc.rust-lang.org/nightly/nightly-rustc/rustc_driver/index.html). I will file an issue for discussion.
23 lines
797 B
TOML
23 lines
797 B
TOML
# The binaries are really slow, if you compile them in 'dev' mode with the defaults.
|
|
# Enable some optimizations even in 'dev' mode, to make tests faster. The basic
|
|
# optimizations enabled by "opt-level=1" don't affect debuggability too much.
|
|
#
|
|
# See https://www.reddit.com/r/rust/comments/gvrgca/this_is_a_neat_trick_for_getting_good_runtime/
|
|
#
|
|
[profile.dev.package."*"]
|
|
# Set the default for dependencies in Development mode.
|
|
opt-level = 3
|
|
|
|
[profile.dev]
|
|
# Turn on a small amount of optimization in Development mode.
|
|
opt-level = 1
|
|
|
|
[build]
|
|
# This is only present for local builds, as it will be overridden
|
|
# by the RUSTDOCFLAGS env var in CI.
|
|
rustdocflags = ["-Arustdoc::private_intra_doc_links"]
|
|
|
|
[alias]
|
|
build_testing = ["build", "--features", "testing"]
|
|
neon = ["run", "--bin", "neon_local"]
|