Skip to content

Conversation

@jacksangl
Copy link

Made minor grammatical improvements and removed redundant words for better readability and clarity in the documentation. No changes to functionality or technical content.

@github-actions
Copy link

github-actions bot commented Feb 7, 2025

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot llvmbot added the BOLT label Feb 7, 2025
@llvmbot
Copy link
Member

llvmbot commented Feb 7, 2025

@llvm/pr-subscribers-bolt

Author: John Sangl (jacksangl)

Changes

Made minor grammatical improvements and removed redundant words for better readability and clarity in the documentation. No changes to functionality or technical content.


Full diff: https://github.com/llvm/llvm-project/pull/126301.diff

1 Files Affected:

  • (modified) bolt/docs/index.rst (+3-3)
diff --git a/bolt/docs/index.rst b/bolt/docs/index.rst
index fce6d25500237dd..bbbeff118540aa7 100644
--- a/bolt/docs/index.rst
+++ b/bolt/docs/index.rst
@@ -75,7 +75,7 @@ Start with cloning LLVM repo:
     > ninja bolt
 
 ``llvm-bolt`` will be available under ``bin/``. Add this directory to
-your path to ensure the rest of the commands in this tutorial work.
+your path ensuring the rest of the commands in this tutorial work.
 
 Optimizing BOLT’s Performance
 -----------------------------
@@ -150,7 +150,7 @@ running on the server for the next 3 minutes use:
     $ perf record -e cycles:u -j any,u -a -o perf.data -- sleep 180
 
 Depending on the application, you may need more samples to be included
-with your profile. It’s hard to tell upfront what would be a sweet spot
+with your profile. It’s often hard to tell upfront what would be a sweet spot
 for your application. We recommend the profile to cover 1B instructions
 as reported by BOLT ``-dyno-stats`` option. If you need to increase the
 number of samples in the profile, you can either run the ``sleep``
@@ -219,7 +219,7 @@ execute ``llvm-bolt``:
 
     $ llvm-bolt <executable> -o <executable>.bolt -data=perf.fdata -reorder-blocks=ext-tsp -reorder-functions=hfsort -split-functions -split-all-cold -split-eh -dyno-stats
 
-If you do need an updated debug info, then add
+If you need updated debug info, then add
 ``-update-debug-sections`` option to the command above. The processing
 time will be slightly longer.
 

@jacksangl jacksangl closed this May 9, 2025
@jacksangl jacksangl reopened this May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants