sys::resource update max_rss accessor doc to reflect the unit per platform #2333
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SteveLauC
reviewed
Mar 16, 2024
src/sys/resource.rs
Outdated
| #[cfg(not(apple_targets))] | ||
| return self.0.ru_maxrss; | ||
| #[cfg(apple_targets)] | ||
| return self.0.ru_maxrss >> 10; |
There was a problem hiding this comment.
What about updating the doc on apple_targets rather than tweaking the code so that we can be more resilient to this kind of changes:
/// The resident set size at its peak,
#[cfg_attr(apple_targets, doc = " in bytes.")]
#[cfg_attr(not(apple_targets), doc = "in kilobytes.")]
pub fn max_rss(&self) -> c_long {
self.0.ru_maxrss
devnexen
force-pushed
the
get_resource_macos
branch
from
3277ffc to
599550b
Compare
SteveLauC
reviewed
Mar 16, 2024
src/sys/resource.rs
Outdated
| @@ -293,7 +293,9 @@ impl Usage { | |||
| TimeVal::from(self.0.ru_stime) | |||
| } | |||
|
|
|||
| /// The resident set size at its peak, in kilobytes. | |||
| /// /// The resident set size at its peak, | |||
There was a problem hiding this comment.
Seems to be redundant:
Suggested change
| /// /// The resident set size at its peak, | |
| /// The resident set size at its peak, |
SteveLauC
reviewed
Mar 16, 2024
src/sys/resource.rs
Outdated
| /// The resident set size at its peak, in kilobytes. | ||
| /// /// The resident set size at its peak, | ||
| #[cfg_attr(apple_targets, doc = " in bytes.")] | ||
| #[cfg_attr(not(apple_targets), doc = "in kilobytes.")] |
There was a problem hiding this comment.
Nit: might be better to have a space here:
Suggested change
| #[cfg_attr(not(apple_targets), doc = "in kilobytes.")] | |
| #[cfg_attr(not(apple_targets), doc = " in kilobytes.")] |
devnexen
force-pushed
the
get_resource_macos
branch
from
599550b to
748a0d2
Compare
SteveLauC
approved these changes
Mar 16, 2024
devnexen
changed the title
devnexen
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
on Apple's devices. this field returns the value in byte. close #2331