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

Update README.md #113

Merged
merged 6 commits into from
Oct 10, 2023
Merged

Conversation

edwarddavidbaker
Copy link
Contributor

@edwarddavidbaker edwarddavidbaker commented Sep 26, 2023

This pull request addresses a collection of relatively straightforward items.

  • Update Errata to link the 13th Generation Intel® Core™ Processor Specification Update.
  • Incorporate Colin King's Perforamnce spelling fix.
  • Document JSON attribute PDISTCounter.
  • Expand CollectPEBSRecord documentation to include 3.
  • Updated JSON metrics format descriptions. Replacing quotes with backticks fixed an issue with <sign>.

Copy link

@lfrusa lfrusa left a comment

Choose a reason for hiding this comment

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

2 spelling updates to review.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@edwarddavidbaker edwarddavidbaker force-pushed the update-readme branch 2 times, most recently from 4aac343 to 0ead6b4 Compare October 4, 2023 17:26
@edwarddavidbaker
Copy link
Contributor Author

Adding two links to help with README.md comparisons.

  1. Current main branch https://github.com/intel/perfmon/blob/main/README.md
  2. This pull request https://github.com/edwarddavidbaker/perfmon/blob/update-readme/README.md

edwarddavidbaker and others added 6 commits October 4, 2023 10:28
This commit adds a link to the 13th Generation Intel Core Processor
Specification Update document.
Incorporate spelling suggestion from
intel#96.

Co-authored-by: Colin Ian King <colin.i.king@gmail.com>
At the moment, ADL and MTL event files include the PDISTCounter
attribute. This commit adds a brief description from the Intel
SDM and a table containing example values.
JSON attribute CollectPEBSRecord can be 0, 1, 2, or 3. This commit
expands README.md to mention value 3.
This commit fixes bullet number 2 'The event may be programmed ...' and
number 3, 'The event must be programmed ...'.
Replaced quotes with single backticks. Indented Name and Alias pairs
since they are nested under Events. Fixed quoting issue with <sign> by
also using backticks.
@edwarddavidbaker
Copy link
Contributor Author

Thanks Caleb.

Copy link

@lfrusa lfrusa left a comment

Choose a reason for hiding this comment

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

Lots of good fixes!

@edwarddavidbaker edwarddavidbaker merged commit 2c51a47 into intel:main Oct 10, 2023
@edwarddavidbaker edwarddavidbaker deleted the update-readme branch October 10, 2023 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants