Skip to content

Refactor and docs: fix typo, reformat code, update README#1009

Merged
opcm merged 5 commits intointel:masterfrom
v1k1nghawk:enhancement_instruction_indentation_typo
Apr 5, 2026
Merged

Refactor and docs: fix typo, reformat code, update README#1009
opcm merged 5 commits intointel:masterfrom
v1k1nghawk:enhancement_instruction_indentation_typo

Conversation

@v1k1nghawk
Copy link
Copy Markdown
Contributor

  • Fix typo in print_output()
  • Convert indentation from tabs to spaces for consistency (according to project's Coding Style)
  • Update README.md to include more user-friendly robust instructions for build directory creation, otherwise, if a user would like to repeat the step they will get an error: "mkdir: cannot create directory ‘build’: File exists" because the directory persists from a previous attempt

Comment thread README.md Outdated
@ogbrugge
Copy link
Copy Markdown
Contributor

ogbrugge commented Apr 1, 2026

Regarding the rest of the changes, I've discussed this with @rdementi in the past but it is probably better to change indentation only there where you make actual changes.

@v1k1nghawk v1k1nghawk force-pushed the enhancement_instruction_indentation_typo branch from 1cf43ec to 735d63d Compare April 1, 2026 13:01
- Fix typo in print_output()
- Convert indentation from tabs to spaces for consistency (according to project's Coding Style)
- Update README.md to include more robust instruction for build directory creation
@v1k1nghawk v1k1nghawk force-pushed the enhancement_instruction_indentation_typo branch from 735d63d to 09ed30d Compare April 1, 2026 13:10
@v1k1nghawk
Copy link
Copy Markdown
Contributor Author

Regarding the rest of the changes, I've discussed this with @rdementi in the past but it is probably better to change indentation only there where you make actual changes.

Thank you for the clarification, I've reverted the indentation changes from the PR.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR cleans up user-facing documentation and messaging by correcting a metric description typo in the PCM output and improving the README build instructions to avoid common “build directory already exists” errors.

Changes:

  • Fixes a typo in the UTIL metric description printed by print_output().
  • Updates README build steps to include options for reusing vs. recreating the build/ directory.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
src/pcm.cpp Corrects a typo in the printed UTIL description string.
README.md Adds build-directory setup guidance (incremental vs. clean build) before the compile steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
v1k1nghawk and others added 2 commits April 1, 2026 17:17
Quick Update rephrasing

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@v1k1nghawk v1k1nghawk requested a review from ogbrugge April 1, 2026 14:43
Comment thread README.md Outdated
@v1k1nghawk v1k1nghawk requested a review from ogbrugge April 2, 2026 07:22
Comment thread README.md Outdated
@v1k1nghawk v1k1nghawk requested a review from opcm April 2, 2026 10:04
@opcm opcm merged commit 0e2a113 into intel:master Apr 5, 2026
30 checks passed
@v1k1nghawk v1k1nghawk deleted the enhancement_instruction_indentation_typo branch April 8, 2026 06:33
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.

4 participants