Skip to content

Commit 09396fd

Browse files
authored
rust: update links to VTune user guide (#147)
* rust: update links to VTune user guide This tweaks the links printed in the Rust documentation to point to the latest version of the API, v2024.1. * review: update some more documentation links
1 parent e4995d9 commit 09396fd

File tree

8 files changed

+16
-15
lines changed

8 files changed

+16
-15
lines changed

rust/integration-tests/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ source vtune-vars.sh
1313
cargo test
1414
```
1515

16-
To install VTune, see the [User
17-
Guide](https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/installation.html).
18-
The environment setup script (e.g., `vtune-vars.sh`) can be found within the VTune installation;
19-
e.g., `$HOME/intel/oneapi/vtune/latest` or `/opt/intel/oneapi/vtune/latest` on
20-
[Linux](https://www.intel.com/content/www/us/en/develop/documentation/get-started-with-vtune/top/linux-os.html).
16+
To install VTune, see the [User Guide]. The environment setup script (e.g., `vtune-vars.sh`) can be
17+
found within the VTune installation; e.g., `$HOME/intel/oneapi/vtune/latest` or
18+
`/opt/intel/oneapi/vtune/latest` on [Linux].
19+
20+
[User Guide]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/installation.html
21+
[Linux]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/get-started-guide/2024-1/linux-os.html

rust/integration-tests/tests/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ fn run_with_collector() {
4141

4242
// Finally, check that the created report actually contains the measured tasks. It may be
4343
// interesting to filter by task here: e.g.,
44-
// https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/command-line-interface/generating-command-line-reports/filtering-and-grouping-reports.html.
44+
// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/filtering-and-grouping-reports.html
4545
let report_stdout = run(&["vtune", "-report", "summary", result_dir_flag]);
4646
assert!(report_stdout.contains("task#1 "));
4747
assert!(report_stdout.contains("task#2 "));

rust/ittapi/src/collection_control.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
/// // Do finalization work here
3838
/// ```
3939
///
40-
/// [Collection Control API]: https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/collection-control-api.html
40+
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/collection-control-api.html
4141
pub fn pause() {
4242
if let Some(pause_fn) = unsafe { ittapi_sys::__itt_pause_ptr__3_0 } {
4343
unsafe { (pause_fn)() };
@@ -54,7 +54,7 @@ pub fn pause() {
5454
///
5555
/// See [pause#example].
5656
///
57-
/// [Collection Control API]: https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/collection-control-api.html
57+
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/collection-control-api.html
5858
pub fn resume() {
5959
if let Some(resume_fn) = unsafe { ittapi_sys::__itt_resume_ptr__3_0 } {
6060
unsafe { (resume_fn)() };
@@ -72,7 +72,7 @@ pub fn resume() {
7272
///
7373
/// Detach behaves similarly to [pause#example].
7474
///
75-
/// [Collection Control API]: https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/collection-control-api.html
75+
/// [Collection Control API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/collection-control-api.html
7676
pub fn detach() {
7777
if let Some(detach_fn) = unsafe { ittapi_sys::__itt_detach_ptr__3_0 } {
7878
unsafe { (detach_fn)() };

rust/ittapi/src/domain.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use std::ffi::CString;
55
/// [Domain API] documentation for more information.
66
///
77
/// [Domain API]:
8-
/// https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/domain-api.html
8+
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/domain-api.html
99
pub struct Domain(*mut ittapi_sys::__itt_domain);
1010
impl Domain {
1111
/// Create a new domain. Note that, if the `ittnotify` library is not initialized, this call
@@ -41,7 +41,7 @@ impl Domain {
4141
/// thread in the process.
4242
///
4343
/// [ITT documentation]:
44-
/// https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/domain-api.html
44+
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/domain-api.html
4545
unsafe impl Sync for Domain {}
4646

4747
#[cfg(test)]

rust/ittapi/src/event.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use std::{ffi::CString, marker::PhantomData};
22

33
/// See the [Event API] documentation.
44
///
5-
/// [Event API]: https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/event-api.html
5+
/// [Event API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/event-api.html
66
///
77
/// ```
88
/// let event = ittapi::Event::new("foo");

rust/ittapi/src/jit.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! is a high-level view of a subset of the full functionality available. See the [JIT Profiling
44
//! API] for more information.
55
//!
6-
//! [JIT Profiling API]: https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/jit-profiling-api.html
6+
//! [JIT Profiling API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/jit-profiling-api.html
77
use anyhow::Context;
88
use std::{ffi::CString, os, ptr};
99

rust/ittapi/src/string.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use std::ffi::CString;
55
/// documentation for more information.
66
///
77
/// [String Handle API]:
8-
/// https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/string-handle-api.html
8+
/// https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/string-handle-api.html
99
#[derive(PartialEq, Eq, Debug)]
1010
pub struct StringHandle(*mut ittapi_sys::__itt_string_handle);
1111
impl StringHandle {

rust/ittapi/src/task.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use crate::{domain::Domain, string::StringHandle};
33
/// A task is a logical unit of work performed by a particular thread. See the [Task API]
44
/// documentation for more information.
55
///
6-
/// [Task API]: https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis/instrumentation-tracing-technology-api-reference/task-api.html
6+
/// [Task API]: https://www.intel.com/content/www/us/en/docs/vtune-profiler/user-guide/2024-1/task-api.html
77
///
88
/// ```
99
/// # use ittapi::{Domain, StringHandle, Task};

0 commit comments

Comments
 (0)