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

Merge DebugCounter documentation #7538

Open
0xdaryl opened this issue Nov 8, 2024 · 0 comments
Open

Merge DebugCounter documentation #7538

0xdaryl opened this issue Nov 8, 2024 · 0 comments

Comments

@0xdaryl
Copy link
Contributor

0xdaryl commented Nov 8, 2024

There are two versions of DebugCounter documentation in the compiler:

  1. https://github.com/eclipse-omr/omr/blob/master/compiler/ras/DebugCounter.md
  2. https://github.com/eclipse-omr/omr/blob/master/doc/compiler/debug/DebugCounters.md

Both are obviously derived from the same root document. They should be compared for differences and merged.

I think version 2) should be the lone document going forward because it is in the better spot and seems to be formatted better already. Version 1) was the original contribution and did undergo a review with comments (#340), so part of this work is ensuring those minimal comments are captured in 2). Afterwards, 1) should be deleted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant