Refactor and docs: fix typo, reformat code, update README by v1k1nghawk · Pull Request #1009 · intel/pcm

v1k1nghawk · 2026-04-01T08:38:41Z

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

ogbrugge · 2026-04-01T10:08:55Z

README.md


 ```
-mkdir build
+rm -rf build && mkdir build


It is probably good to mention here that one can use mkdir -p here to prevent a full rebuild. If one wants a full rebuild then delete it all and start over.

Agreed. Mentioned both cases as suggested.

ogbrugge · 2026-04-01T10:11:46Z

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.

- 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 · 2026-04-01T13:18:04Z

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.

Copilot

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.

README.md

Copilot · 2026-04-01T14:00:31Z

README.md

+* Quick Update: Run `mkdir -p build` to skip a full rebuild and preserve existing build artifacts.
+* OR
+* Clean Start: Run `rm -rf build && mkdir build` to do a full rebuild.


The "* OR" line renders as a third bullet item, which can look like an instruction step rather than a separator between the two options. Consider using plain text (e.g., "or") or restructuring the list (e.g., numbered options) to make the mutually exclusive choice clearer.

Suggested change

* Quick Update: Run `mkdir -p build` to skip a full rebuild and preserve existing build artifacts.

* OR

* Clean Start: Run `rm -rf build && mkdir build` to do a full rebuild.

1. Quick Update: Run `mkdir -p build` to skip a full rebuild and preserve existing build artifacts.

2. Clean Start: Run `rm -rf build && mkdir build` to do a full rebuild.

Copilot · 2026-04-01T14:00:31Z

README.md

+Compile:
 ```
-mkdir build
 cd build
 cmake ..
 cmake --build .


The compile snippet now starts with cd build but no longer includes any build directory creation command in the code block. A copy/paste of the "Compile" block alone will fail on a fresh checkout (or if the user skips the section above). Consider including the chosen directory-creation command in the fenced block(s) or otherwise making the required step unmissable.

I think it is ok this way, Copilot does have a point that in the Compile section there is no mkdir build so you might move the comment into the compile section but before the ``` line. This is up to you though, i can live with this without.

Let's take Copilot's suggestion, I've updated the section to include it.

Quick Update rephrasing Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

ogbrugge · 2026-04-01T15:58:54Z

README.md

 * Clean Start: Run `rm -rf build && mkdir build` to do a full rebuild.

-Compile:
+then compile:


If you have done a previous build you do not need to do a mkdir -p build because it exists, you can go straight to the "cd build" step.

So something like this perhaps?

On first build or in case you want to throw everything away and start from scratch then start with this:
rm -rf build && mkdir build
If you have a previous build and want to continue building with that then you can skip the deletion of the build directory.

cd build

Yes, sounds logical. I've rephrased the statements based on those suggestions. Thanks!

opcm · 2026-04-02T08:05:51Z

README.md


+Choose **one** of the following build methods:
+* Incremental Build (Fastest): if you have a previous build to reuse the existing `build` directory and preserve previous build artifacts, go straight to the `cd build` step.
+* Clean Build (From Scratch): Run `rm -rf build && mkdir build` for your first build, or for a full rebuild to ensure a "clean state" by deleting all previous build data.


does this work on Windows? the expectation is that it works on both *nix/BSD-like OSes and Windows

ogbrugge reviewed Apr 1, 2026

View reviewed changes

v1k1nghawk force-pushed the enhancement_instruction_indentation_typo branch from 1cf43ec to 735d63d Compare April 1, 2026 13:01

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

09ed30d

- 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 force-pushed the enhancement_instruction_indentation_typo branch from 735d63d to 09ed30d Compare April 1, 2026 13:10

opcm requested a review from Copilot April 1, 2026 13:57

Copilot started reviewing on behalf of opcm April 1, 2026 13:58 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

v1k1nghawk and others added 2 commits April 1, 2026 17:17

Update README.md

9490904

Quick Update rephrasing Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

docs: clarify build directory creation steps

22ea53c

v1k1nghawk requested a review from ogbrugge April 1, 2026 14:43

ogbrugge reviewed Apr 1, 2026

View reviewed changes

docs: additional clarifications for build directory creation steps

28be3d2

v1k1nghawk requested a review from ogbrugge April 2, 2026 07:22

opcm reviewed Apr 2, 2026

View reviewed changes

Conversation

v1k1nghawk commented Apr 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogbrugge commented Apr 1, 2026

Uh oh!

v1k1nghawk commented Apr 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogbrugge Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ogbrugge Apr 1, 2026 •

edited

Loading