Skip to content

Commit 0a88840

Browse files
author
Ariel Ben-Yehuda
committed
docs: fix links in docs
1 parent aa4d0bd commit 0a88840

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/lib.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,10 @@
2020
//! so make sure there is a `libasyncProfiler.so` in the search path[^1].
2121
//!
2222
//! [^1]: the dlopen search path includes RPATH and LD_LIBRARY_PATH, but *not* the current directory to avoid current directory attacks.
23-
//! [dlopen(3)]: <https://linux.die.net/man/3/dlopen>
2423
//!
25-
//! You can use the [S3Reporter], which uploads the reports to an S3 bucket, as follows:
24+
//! [dlopen(3)]: https://linux.die.net/man/3/dlopen
25+
//!
26+
//! You can use the [`S3Reporter`], which uploads the reports to an S3 bucket, as follows:
2627
//!
2728
//! ```no_run
2829
//! # use async_profiler_agent::profiler::{ProfilerBuilder, SpawnError};
@@ -51,7 +52,7 @@
5152
//! # }
5253
//! ```
5354
//!
54-
//! The [S3Reporter] uploads each report in a `zip` file, that currently contains 2 files:
55+
//! The [`S3Reporter`] uploads each report in a `zip` file, that currently contains 2 files:
5556
//! 1. a [JFR] as `async_profiler_dump_0.jfr`
5657
//! 2. metadata as `metadata.json`, in format [`reporter::s3::MetadataJson`].
5758
//!
@@ -61,6 +62,7 @@
6162
//! In addition to the S3 reporter, this crate also includes [`LocalReporter`] that writes to a directory, and a `MultiReporter` that allows combining reporters. You can also write your own reporter (via the `Reporter` trait) to upload the profile results to your favorite profiler backend.
6263
//!
6364
//! [`LocalReporter`]: reporter::local::LocalReporter
65+
//! [`S3Reporter`]: reporter::s3::S3Reporter
6466
//! [JFR]: https://docs.oracle.com/javacomponents/jmc-5-4/jfr-runtime-guide/about.htm
6567
//!
6668
//! #### Sample program

0 commit comments

Comments
 (0)