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.

Sign up for GitHub

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

Jump to bottom

Improve the code readability with more comments #881

Open
honggyukim opened this issue Sep 18, 2019 · 1 comment
Open

Improve the code readability with more comments #881

honggyukim opened this issue Sep 18, 2019 · 1 comment
Labels
contributon2019 good first issue

Comments

@honggyukim
Copy link
Collaborator

uftrace code base may not be easy to understand for new users, so I believe that it'd be a lot better to have more comments on its code base.

If someone cannot understand some code, it needs to have descriptive comments. Anyone can send a PR with helpful comments at the code location while navigating the source code.
@honggyukim
Copy link
Collaborator Author

For example, I added the following commit to explain how PLT works with GOT.

  • 4b283f7 plthook: Add a comment for mcount_arch_plthook_addr

@DanielTimLee DanielTimLee mentioned this issue Sep 18, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
contributon2019 good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@honggyukim