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.

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

rust: use evergreen URL for doc links #148

Merged
merged 1 commit into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions rust/integration-tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ To install VTune, see the [User Guide]. The environment setup script (e.g., `vtu
found within the VTune installation; e.g., `$HOME/intel/oneapi/vtune/latest` or
`/opt/intel/oneapi/vtune/latest` on [Linux].

[User Guide]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/installation.html
[Linux]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/get-started-guide/2024-1/linux-os.html
[User Guide]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/installation.html
[Linux]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/get-started-guide/current/linux-os.html
2 changes: 1 addition & 1 deletion rust/integration-tests/tests/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ fn run_with_collector() {

// Finally, check that the created report actually contains the measured tasks. It may be
// interesting to filter by task here: e.g.,
// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/filtering-and-grouping-reports.html
// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/filtering-and-grouping-reports.html
let report_stdout = run(&["vtune", "-report", "summary", result_dir_flag]);
assert!(report_stdout.contains("task#1 "));
assert!(report_stdout.contains("task#2 "));
Expand Down
6 changes: 3 additions & 3 deletions rust/ittapi/src/collection_control.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
/// // Do finalization work here
/// ```
///
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/collection-control-api.html
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/collection-control-api.html
pub fn pause() {
if let Some(pause_fn) = unsafe { ittapi_sys::__itt_pause_ptr__3_0 } {
unsafe { (pause_fn)() };
Expand All @@ -54,7 +54,7 @@ pub fn pause() {
///
/// See [pause#example].
///
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/collection-control-api.html
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/collection-control-api.html
pub fn resume() {
if let Some(resume_fn) = unsafe { ittapi_sys::__itt_resume_ptr__3_0 } {
unsafe { (resume_fn)() };
Expand All @@ -72,7 +72,7 @@ pub fn resume() {
///
/// Detach behaves similarly to [pause#example].
///
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/collection-control-api.html
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/collection-control-api.html
pub fn detach() {
if let Some(detach_fn) = unsafe { ittapi_sys::__itt_detach_ptr__3_0 } {
unsafe { (detach_fn)() };
Expand Down
4 changes: 2 additions & 2 deletions rust/ittapi/src/domain.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use std::ffi::CString;
/// [Domain API] documentation for more information.
///
/// [Domain API]:
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/domain-api.html
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/domain-api.html
pub struct Domain(*mut ittapi_sys::__itt_domain);
impl Domain {
/// Create a new domain. Note that, if the `ittnotify` library is not initialized, this call
Expand Down Expand Up @@ -41,7 +41,7 @@ impl Domain {
/// thread in the process.
///
/// [ITT documentation]:
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/domain-api.html
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/domain-api.html
unsafe impl Sync for Domain {}

#[cfg(test)]
Expand Down
2 changes: 1 addition & 1 deletion rust/ittapi/src/event.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use std::{ffi::CString, marker::PhantomData};

/// See the [Event API] documentation.
///
/// [Event API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/event-api.html
/// [Event API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/event-api.html
///
/// ```
/// let event = ittapi::Event::new("foo");
Expand Down
2 changes: 1 addition & 1 deletion rust/ittapi/src/jit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//! is a high-level view of a subset of the full functionality available. See the [JIT Profiling
//! API] for more information.
//!
//! [JIT Profiling API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/jit-profiling-api.html
//! [JIT Profiling API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/jit-profiling-api.html
use anyhow::Context;
use std::{ffi::CString, os, ptr};

Expand Down
2 changes: 1 addition & 1 deletion rust/ittapi/src/region.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ impl Region {
/// used for fine-grained profiling, such as [anomaly detection] (a preview feature of VTune).
///
/// [anomaly detection]:
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/anomaly-detection-analysis.html
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/anomaly-detection-analysis.html
///
/// ```
/// # use ittapi::Region;
Expand Down
2 changes: 1 addition & 1 deletion rust/ittapi/src/string.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use std::ffi::CString;
/// documentation for more information.
///
/// [String Handle API]:
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/string-handle-api.html
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/string-handle-api.html
#[derive(PartialEq, Eq, Debug)]
pub struct StringHandle(*mut ittapi_sys::__itt_string_handle);
impl StringHandle {
Expand Down
2 changes: 1 addition & 1 deletion rust/ittapi/src/task.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use crate::{domain::Domain, string::StringHandle};
/// A task is a logical unit of work performed by a particular thread. See the [Task API]
/// documentation for more information.
///
/// [Task API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/task-api.html
/// [Task API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/current/task-api.html
///
/// ```
/// # use ittapi::{Domain, StringHandle, Task};
Expand Down