Skip to content

Remove doc(html_root_url) attribute from all crates.#2384

Merged
davidbarsky merged 1 commit intotokio-rs:masterfrom
LukeMathWalker:remove-html-root-attribute
Nov 16, 2022
Merged

Remove doc(html_root_url) attribute from all crates.#2384
davidbarsky merged 1 commit intotokio-rs:masterfrom
LukeMathWalker:remove-html-root-attribute

Conversation

@LukeMathWalker
Copy link
Contributor

@LukeMathWalker LukeMathWalker commented Nov 16, 2022

Fixes #2383

davidbarsky
davidbarsky approved these changes Nov 16, 2022
View reviewed changes
Copy link
Member

@davidbarsky davidbarsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much!

@davidbarsky davidbarsky merged commit 60c60be into tokio-rs:master Nov 16, 2022
@hawkw
Copy link
Member

hawkw commented Nov 16, 2022

Great, thank you!

@LukeMathWalker LukeMathWalker mentioned this pull request Nov 20, 2022
Merged
hawkw pushed a commit that referenced this pull request Apr 21, 2023
@LukeMathWalker @hawkw
chore: Remove doc(html_root_url) attribute from all crates. (#2384)
ac8ddf4 
Fixes #2383.
; Conflicts:
;	tracing-appender/src/lib.rs
;	tracing-attributes/src/lib.rs
;	tracing-core/src/lib.rs
;	tracing-error/src/lib.rs
;	tracing-futures/src/lib.rs
;	tracing-log/src/lib.rs
;	tracing-opentelemetry/src/lib.rs
;	tracing-serde/src/lib.rs
;	tracing-subscriber/src/lib.rs
;	tracing/src/lib.rs
@hawkw hawkw mentioned this pull request Apr 21, 2023
Merged
hawkw pushed a commit that referenced this pull request Apr 21, 2023
@LukeMathWalker @hawkw
chore: Remove doc(html_root_url) attribute from all crates. (#2384)
6c55b66 
Fixes #2383.
; Conflicts:
;	tracing-appender/src/lib.rs
;	tracing-attributes/src/lib.rs
;	tracing-core/src/lib.rs
;	tracing-error/src/lib.rs
;	tracing-futures/src/lib.rs
;	tracing-log/src/lib.rs
;	tracing-opentelemetry/src/lib.rs
;	tracing-serde/src/lib.rs
;	tracing-subscriber/src/lib.rs
;	tracing/src/lib.rs
hawkw added a commit that referenced this pull request Apr 22, 2023
@hawkw
subscriber: prepare to release v0.3.17
5048686 
# 0.3.17 (April 21, 2023)

This release of `tracing-subscriber` fixes a build error when using
`env-filter` with recent versions of the `regex` crate. It also
introduces several minor API improvements.

### Fixed

- **env-filter**: Add "unicode-case" and "unicode-perl" to the `regex`
  dependency, fixing a build error with recent versions of `regex`
  (#2566)
- A number of minor documentation typos and other fixes (#2384,
  #2378, #2368, #2548)

### Added

- **filter**: Add `fmt::Display` impl for `filter::Targets` ([2343)
- **fmt**: Made `with_ansi(false)` no longer require the "ansi" feature,
  so that ANSI formatting escapes can be disabled without requiring
  ANSI-specific dependencies (#2535)

### Changed

- **fmt**: Dim targets in the `Compact` formatter, matching the default
  formatter (#2409)

Thanks to @keepsimple1, @andrewhalle, @LeoniePhiline, @LukeMathWalker,
@howardjohn, @daxpedda, and @dbidwell94 for contributing to this
release!
@hawkw hawkw mentioned this pull request Apr 22, 2023
Merged
hawkw added a commit that referenced this pull request Apr 22, 2023
@hawkw
subscriber: prepare to release v0.3.17 (#2571)
0114ec1 
# 0.3.17 (April 21, 2023)

This release of `tracing-subscriber` fixes a build error when using
`env-filter` with recent versions of the `regex` crate. It also
introduces several minor API improvements.

### Fixed

- **env-filter**: Add "unicode-case" and "unicode-perl" to the `regex`
  dependency, fixing a build error with recent versions of `regex`
  (#2566)
- A number of minor documentation typos and other fixes (#2384, #2378,
  #2368, #2548)

### Added

- **filter**: Add `fmt::Display` impl for `filter::Targets` (#2343)
- **fmt**: Made `with_ansi(false)` no longer require the "ansi" feature,
  so that ANSI formatting escapes can be disabled without requiring
  ANSI-specific dependencies (#2532)

### Changed

- **fmt**: Dim targets in the `Compact` formatter, matching the default
  formatter (#2409)

Thanks to @keepsimple1, @andrewhalle, @LeoniePhiline, @LukeMathWalker,
@howardjohn, @daxpedda, and @dbidwell94 for contributing to this
release!
@davidbarsky davidbarsky mentioned this pull request Sep 26, 2023
Merged
hongquan added a commit to hongquan/tracing that referenced this pull request Oct 10, 2023
@hongquan
Merge tag 'tracing-subscriber-0.3.17' into feat/tracing-journald
168d33d 
This release of `tracing-subscriber` fixes a build error when using
`env-filter` with recent versions of the `regex` crate. It also
introduces several minor API improvements.

- **env-filter**: Add "unicode-case" and "unicode-perl" to the `regex`
  dependency, fixing a build error with recent versions of `regex`
  (tokio-rs#2566)
- A number of minor documentation typos and other fixes (tokio-rs#2384, tokio-rs#2378,
  tokio-rs#2368, tokio-rs#2548)

- **filter**: Add `fmt::Display` impl for `filter::Targets` (tokio-rs#2343)
- **fmt**: Made `with_ansi(false)` no longer require the "ansi" feature,
  so that ANSI formatting escapes can be disabled without requiring
  ANSI-specific dependencies (tokio-rs#2532)

- **fmt**: Dim targets in the `Compact` formatter, matching the default
  formatter (tokio-rs#2409)

Thanks to @keepsimple1, @andrewhalle, @LeoniePhiline, @LukeMathWalker,
@howardjohn, @daxpedda, and @dbidwell94 for contributing to this
release!
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
@LukeMathWalker @kaffarell
chore: Remove doc(html_root_url) attribute from all crates. (tokio-…
b334aba 
…rs#2384)

Fixes tokio-rs#2383.
; Conflicts:
;	tracing-appender/src/lib.rs
;	tracing-attributes/src/lib.rs
;	tracing-core/src/lib.rs
;	tracing-error/src/lib.rs
;	tracing-futures/src/lib.rs
;	tracing-log/src/lib.rs
;	tracing-opentelemetry/src/lib.rs
;	tracing-serde/src/lib.rs
;	tracing-subscriber/src/lib.rs
;	tracing/src/lib.rs
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
@hawkw @kaffarell
subscriber: prepare to release v0.3.17 (tokio-rs#2571)
d27d4f1 
# 0.3.17 (April 21, 2023)

This release of `tracing-subscriber` fixes a build error when using
`env-filter` with recent versions of the `regex` crate. It also
introduces several minor API improvements.

### Fixed

- **env-filter**: Add "unicode-case" and "unicode-perl" to the `regex`
  dependency, fixing a build error with recent versions of `regex`
  (tokio-rs#2566)
- A number of minor documentation typos and other fixes (tokio-rs#2384, tokio-rs#2378,
  tokio-rs#2368, tokio-rs#2548)

### Added

- **filter**: Add `fmt::Display` impl for `filter::Targets` (tokio-rs#2343)
- **fmt**: Made `with_ansi(false)` no longer require the "ansi" feature,
  so that ANSI formatting escapes can be disabled without requiring
  ANSI-specific dependencies (tokio-rs#2532)

### Changed

- **fmt**: Dim targets in the `Compact` formatter, matching the default
  formatter (tokio-rs#2409)

Thanks to @keepsimple1, @andrewhalle, @LeoniePhiline, @LukeMathWalker,
@howardjohn, @daxpedda, and @dbidwell94 for contributing to this
release!
hds pushed a commit that referenced this pull request Dec 1, 2024
@0xPoe
chore: remove outdated release instructions (#3154)
66cafe5 
The outdated release instructions have been removed.

Follow up of #2384.

Signed-off-by: Rustin170506 <tech@rustin.me>
@arpadav
Copy link

arpadav commented Dec 23, 2024

Was this just removed because it was neglected to be updated?

I have an internal project where our offline docs aren't properly linking to tracing because these lines were removed. According to rustdoc, the html_root_url attribute is used as a fallback for this exact reason. Most other crates do include this and have no problems linking.

The motivation behind this is because our project docs are all local/offline and generated using cargo doc --workspace --no-deps. Everything in our workspace is related to the project, for which we care about the docs. And yes, if I were to remove --no-deps then it links correctly, since it is generated offline and to our servers. The problem is then we have 500+ dependencies + packages to sift through on the left-hand side (see attached) which eliminates the entire point of having an easily navigable doc for just our workspace.

image

I know this is less of a tracing related issue and more of a general way cargo doc is written, but are there plans for this to be re-introduced?

@arpadav
Copy link

arpadav commented Dec 23, 2024

It has come to my attention that this is no longer recommended, but there still seems to be a rift between offline-docs users and devs who need to tediously update this archaic macro.

tracing devs, you can ignore my ramblings, and no need to answer the comment above: it's fine if kept removed

But for any users who find this and encounter the same issue, you can use this unstable flag by editing your .cargo/config.toml to map docs. E.g.:

# in `.cargo/config.toml`
[doc.extern-map.registries]
crates-io = "https://docs.rs/"

then to generate docs

cargo +nightly doc --no-deps --workspace -Zrustdoc-map -Zunstable-options

hds pushed a commit that referenced this pull request May 27, 2025
@0xPoe @hds
chore: remove outdated release instructions (#3154)
6a64d83 
The outdated release instructions have been removed.

Follow up of #2384.

Signed-off-by: Rustin170506 <tech@rustin.me>
hds pushed a commit that referenced this pull request Jun 3, 2025
@0xPoe @hds
chore: remove outdated release instructions (#3154)
3c07b08 
The outdated release instructions have been removed.

Follow up of #2384.

Signed-off-by: Rustin170506 <tech@rustin.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@davidbarsky davidbarsky davidbarsky approved these changes

@jtescher jtescher Awaiting requested review from jtescher

@yaahc yaahc Awaiting requested review from yaahc yaahc is a code owner

@hawkw hawkw Awaiting requested review from hawkw hawkw is a code owner

@carllerche carllerche Awaiting requested review from carllerche carllerche is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

tracing-core referring to documentation for an old version

4 participants

@LukeMathWalker @hawkw @arpadav @davidbarsky