Skip to content

Commit e6c351f

Browse files
cijothomaslalitb
cijothomas
and
lalitb
authored
More consistent readme for msrv (#2336)
Co-authored-by: Lalit Kumar Bhasin <[email protected]>
1 parent 129ca03 commit e6c351f

File tree

15 files changed

+103
-19
lines changed

15 files changed

+103
-19
lines changed

‎README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,10 @@ analysis in order to understand your software's performance and behavior. You
1717
can export and analyze them using [Prometheus], [Jaeger], and other
1818
observability tools.
1919

20-
*Compiler support: [requires `rustc` 1.70+][msrv]*
20+
*[Supported Rust Versions](#supported-rust-versions)*
2121

2222
[Prometheus]: https://prometheus.io
2323
[Jaeger]: https://www.jaegertracing.io
24-
[msrv]: #supported-rust-versions
2524

2625
## Project Status
2726

‎opentelemetry-appender-log/src/lib.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
//!
33
//! This library implements a log appender for the [`log`] crate using the [Logs Bridge API].
44
//!
5+
//! *[Supported Rust Versions](#supported-rust-versions)*
6+
//!
57
//! # Getting Started
68
//!
79
//! The bridge requires configuration on both the `log` and OpenTelemetry sides.
@@ -93,6 +95,20 @@
9395
//! - `with-serde`: Support complex values as attributes without stringifying them.
9496
//!
9597
//! [Logs Bridge API]: https://opentelemetry.io/docs/specs/otel/logs/bridge-api/
98+
//!
99+
//! ## Supported Rust Versions
100+
//!
101+
//! OpenTelemetry is built against the latest stable release. The minimum
102+
//! supported version is 1.70. The current OpenTelemetry version is not
103+
//! guaranteed to build on Rust versions earlier than the minimum supported
104+
//! version.
105+
//!
106+
//! The current stable Rust compiler and the three most recent minor versions
107+
//! before it will always be supported. For example, if the current stable
108+
//! compiler version is 1.49, the minimum supported version will not be
109+
//! increased past 1.46, three minor versions prior. Increasing the minimum
110+
//! supported compiler version is not considered a semver breaking change as
111+
//! long as doing so complies with this policy.
96112
97113
use log::{Level, Metadata, Record};
98114
use opentelemetry::{

‎opentelemetry-appender-tracing/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,18 @@ management, and export of telemetry. A major goal of OpenTelemetry is that you
3232
can easily instrument your applications or systems, no matter their language,
3333
infrastructure, or runtime environment. Crucially, the storage and visualization
3434
of telemetry is intentionally left to other tools.
35+
36+
*[Supported Rust Versions](#supported-rust-versions)*
37+
38+
## Supported Rust Versions
39+
40+
OpenTelemetry is built against the latest stable release. The minimum supported
41+
version is 1.70. The current OpenTelemetry version is not guaranteed to build
42+
on Rust versions earlier than the minimum supported version.
43+
44+
The current stable Rust compiler and the three most recent minor versions
45+
before it will always be supported. For example, if the current stable compiler
46+
version is 1.49, the minimum supported version will not be increased past 1.46,
47+
three minor versions prior. Increasing the minimum supported compiler version
48+
is not considered a semver breaking change as long as doing so complies with
49+
this policy.

‎opentelemetry-http/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,18 @@ management, and export of telemetry. A major goal of OpenTelemetry is that you
2828
can easily instrument your applications or systems, no matter their language,
2929
infrastructure, or runtime environment. Crucially, the storage and visualization
3030
of telemetry is intentionally left to other tools.
31+
32+
*[Supported Rust Versions](#supported-rust-versions)*
33+
34+
## Supported Rust Versions
35+
36+
OpenTelemetry is built against the latest stable release. The minimum supported
37+
version is 1.70. The current OpenTelemetry version is not guaranteed to build
38+
on Rust versions earlier than the minimum supported version.
39+
40+
The current stable Rust compiler and the three most recent minor versions
41+
before it will always be supported. For example, if the current stable compiler
42+
version is 1.49, the minimum supported version will not be increased past 1.46,
43+
three minor versions prior. Increasing the minimum supported compiler version
44+
is not considered a semver breaking change as long as doing so complies with
45+
this policy.

‎opentelemetry-jaeger-propagator/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,18 @@ management, and export of telemetry. A major goal of OpenTelemetry is that you
2828
can easily instrument your applications or systems, no matter their language,
2929
infrastructure, or runtime environment. Crucially, the storage and visualization
3030
of telemetry is intentionally left to other tools.
31+
32+
*[Supported Rust Versions](#supported-rust-versions)*
33+
34+
## Supported Rust Versions
35+
36+
OpenTelemetry is built against the latest stable release. The minimum supported
37+
version is 1.70. The current OpenTelemetry version is not guaranteed to build
38+
on Rust versions earlier than the minimum supported version.
39+
40+
The current stable Rust compiler and the three most recent minor versions
41+
before it will always be supported. For example, if the current stable compiler
42+
version is 1.49, the minimum supported version will not be increased past 1.46,
43+
three minor versions prior. Increasing the minimum supported compiler version
44+
is not considered a semver breaking change as long as doing so complies with
45+
this policy.

‎opentelemetry-jaeger-propagator/src/lib.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
//! *Compiler support: [requires `rustc` 1.64+][msrv]*
1+
//! *[Supported Rust Versions](#supported-rust-versions)*
22
//!
33
//! [Jaeger Docs]: https://www.jaegertracing.io/docs/
44
//! [jaeger-deprecation]: https://github.com/open-telemetry/opentelemetry-specification/pull/2858/files
55
//! [jaeger-otlp]: https://www.jaegertracing.io/docs/1.38/apis/#opentelemetry-protocol-stable
66
//! [otlp-exporter]: https://docs.rs/opentelemetry-otlp/latest/opentelemetry_otlp/
7-
//! [msrv]: #supported-rust-versions
87
//! [jaeger propagation format]: https://www.jaegertracing.io/docs/1.18/client-libraries/#propagation-format
98
//!
109
//! # Supported Rust Versions

‎opentelemetry-otlp/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,10 @@ can easily instrument your applications or systems, no matter their language,
3030
infrastructure, or runtime environment. Crucially, the storage and visualization
3131
of telemetry is intentionally left to other tools.
3232

33-
*Compiler support: [requires `rustc` 1.71.1+][msrv]*
33+
*[Supported Rust Versions](#supported-rust-versions)*
3434

3535
[Prometheus]: https://prometheus.io
3636
[Jaeger]: https://www.jaegertracing.io
37-
[msrv]: #supported-rust-versions
3837

3938
## Getting started
4039

‎opentelemetry-proto/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,17 @@
66
This crate contains generated files from [opentelemetry-proto](https://github.com/open-telemetry/opentelemetry-proto)
77
repository and transformation between types from generated files and types defined in [opentelemetry](https://github.com/open-telemetry/opentelemetry-rust/tree/main/opentelemetry).
88

9+
*[Supported Rust Versions](#supported-rust-versions)*
910

10-
*Compiler support: [requires `rustc` 1.71.1+]
11+
## Supported Rust Versions
12+
13+
OpenTelemetry is built against the latest stable release. The minimum supported
14+
version is 1.71.1. The current OpenTelemetry version is not guaranteed to build
15+
on Rust versions earlier than the minimum supported version.
16+
17+
The current stable Rust compiler and the three most recent minor versions
18+
before it will always be supported. For example, if the current stable compiler
19+
version is 1.49, the minimum supported version will not be increased past 1.46,
20+
three minor versions prior. Increasing the minimum supported compiler version
21+
is not considered a semver breaking change as long as doing so complies with
22+
this policy.

‎opentelemetry-sdk/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,10 @@ can easily instrument your applications or systems, no matter their language,
2929
infrastructure, or runtime environment. Crucially, the storage and visualization
3030
of telemetry is intentionally left to other tools.
3131

32-
*Compiler support: [requires `rustc` 1.70+][msrv]*
32+
*[Supported Rust Versions](#supported-rust-versions)*
3333

3434
[Prometheus]: https://prometheus.io
3535
[Jaeger]: https://www.jaegertracing.io
36-
[msrv]: #supported-rust-versions
3736

3837
### What does this crate contain?
3938

@@ -104,7 +103,7 @@ See [docs](https://docs.rs/opentelemetry-sdk).
104103
## Supported Rust Versions
105104

106105
OpenTelemetry is built against the latest stable release. The minimum supported
107-
version is 1.65. The current OpenTelemetry version is not guaranteed to build
106+
version is 1.70. The current OpenTelemetry version is not guaranteed to build
108107
on Rust versions earlier than the minimum supported version.
109108

110109
The current stable Rust compiler and the three most recent minor versions

‎opentelemetry-sdk/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Implements the [`SDK`] component of [OpenTelemetry].
22
//!
3-
//! *Compiler support: [requires `rustc` 1.70+][msrv]*
3+
//! *[Supported Rust Versions](#supported-rust-versions)*
44
//!
55
//! [`SDK`]: https://opentelemetry.io/docs/specs/otel/overview/#sdk
66
//! [OpenTelemetry]: https://opentelemetry.io/docs/what-is-opentelemetry/

0 commit comments

Comments
 (0)