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

doc: Update README.md for user space function tracing #1742

Merged
merged 1 commit into from Jul 8, 2023

Conversation

honggyukim
Copy link
Collaborator

uftrace provides mulitiple ways for user space function tracing, but it might be confusing to users suggesting all the options in README.md.

We better inform a few options including -pg, -finstrument-functions and -fpatchable-function-entry=N.

@honggyukim honggyukim added the doc label Jul 2, 2023
README.md Outdated
or with code compiled with with `-pg`, `-mfentry`, `-finstrument-functions`,
or using clang with `-fxray-instrument`)
or with code compiled with with `-pg`, `-finstrument-functions` or using
`-fpatchable-function-entry=N` with selective NOP patching at runtime)
Copy link
Owner

Choose a reason for hiding this comment

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

I think the last part would be "or using -fpatchable-function-entry=N for selective NOP patching)".

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ack. I just updated it.

uftrace provides mulitiple ways for user space function tracing, but it
might be confusing to users suggesting all the options in README.md.

We better inform a few options including -pg, -finstrument-functions and
-fpatchable-function-entry=N.

Signed-off-by: Honggyu Kim <honggyu.kp@gmail.com>
Copy link
Owner

@namhyung namhyung left a comment

Choose a reason for hiding this comment

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

LGTM

@honggyukim honggyukim merged commit 780c052 into namhyung:master Jul 8, 2023
3 checks passed
@honggyukim honggyukim deleted the doc/update-README branch July 8, 2023 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants