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

Minor Heapster docfixes #1752

Merged
merged 4 commits into from
Dec 15, 2022
Merged

Minor Heapster docfixes #1752

merged 4 commits into from
Dec 15, 2022

Conversation

RyanGlScott
Copy link
Contributor

This PR contains two minor documentation fixes involving Heapster:

  • In the documentation for heapster_assume_fun_rename, nm_t is a typo and is actually meant to refer to nm_to.
  • The documentation for fieldsh(p) claims that it acts on a pointer of unknown size. This isn't really true, however, as it is really a shorthand for fieldsh(w,p), where w is the current pointer size.

`nm_t` is a typo and is actually meant to refer to `nm_to`.

[ci skip]
The documentation for `fieldsh(p)` claims that it acts on a pointer of unknown
size. This isn't really true, however, as it is really a shorthand for
`fieldsh(w,p)`, where `w` is the current pointer size. I found the original
documentation misleading enough to the point where I think it deserves to be
rewritten, which I have accomplished in this patch.

[ci skip]
@RyanGlScott RyanGlScott added the subsystem: heapster Issues specifically related to memory verification using Heapster label Oct 11, 2022
@RyanGlScott RyanGlScott requested a review from m-yac November 18, 2022 20:49
Copy link
Contributor

@eddywestbrook eddywestbrook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These doc fixes are helpful, thanks Ryan!

@RyanGlScott RyanGlScott added the PR: ready to merge Magic flag for pull requests to ask Mergify to merge given an approval and a successful CI run label Dec 14, 2022
@mergify mergify bot merged commit 6170630 into master Dec 15, 2022
@mergify mergify bot deleted the heapster-docfixes branch December 15, 2022 03:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: ready to merge Magic flag for pull requests to ask Mergify to merge given an approval and a successful CI run subsystem: heapster Issues specifically related to memory verification using Heapster
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants