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

Merge DebugCounter documentation #7538

Open
0xdaryl opened this issue Nov 8, 2024 · 1 comment · May be fixed by #7684
Open

Merge DebugCounter documentation #7538

0xdaryl opened this issue Nov 8, 2024 · 1 comment · May be fixed by #7684
Assignees
@a7ehuo
Labels
comp:compiler documentation help wanted

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.
@a7ehuo
Copy link
Contributor

a7ehuo commented Feb 25, 2025

I will take a look at this one

@a7ehuo a7ehuo self-assigned this Feb 25, 2025
a7ehuo added a commit to a7ehuo/omr that referenced this issue Mar 7, 2025
@a7ehuo
Merge the two documents on debugCounter
be4a326 
Merged the content from ras/DebugCounter.md
into debug/DebugCounters.md, and removed
ras/DebugCounter.md.

Closes: eclipse-omr#7538
Signed-off-by: Annabelle Huo <[email protected]>
@a7ehuo a7ehuo linked a pull request Mar 7, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@a7ehuo a7ehuo

Labels
comp:compiler documentation help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Merge the two documents on debugCounter a7ehuo/omr
2 participants
@0xdaryl @a7ehuo