[llvm] [llvm] Proofread Benchmarking.rst (PR #155792)
Kazu Hirata via llvm-commits
llvm-commits at lists.llvm.org
Thu Aug 28 01:53:44 PDT 2025
https://github.com/kazutakahirata created https://github.com/llvm/llvm-project/pull/155792
None
>From df5b0bcb9448856b467d6e35e4634424be451992 Mon Sep 17 00:00:00 2001
From: Kazu Hirata <kazu at google.com>
Date: Wed, 27 Aug 2025 08:34:45 -0700
Subject: [PATCH] [llvm] Proofread Benchmarking.rst
---
llvm/docs/Benchmarking.rst | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/llvm/docs/Benchmarking.rst b/llvm/docs/Benchmarking.rst
index cd7b835e47c53..d168965114459 100644
--- a/llvm/docs/Benchmarking.rst
+++ b/llvm/docs/Benchmarking.rst
@@ -17,24 +17,24 @@ for example.
General
================================
-* Use a high resolution timer, e.g. perf under linux.
+* Use a high-resolution timer, e.g., perf under Linux.
* Run the benchmark multiple times to be able to recognize noise.
* Disable as many processes or services as possible on the target system.
-* Disable frequency scaling, turbo boost and address space
- randomization (see OS specific section).
+* Disable frequency scaling, Turbo Boost and address space
+ randomization (see OS-specific section).
-* Static link if the OS supports it. That avoids any variation that
+* Use static linking if the OS supports it. That avoids any variation that
might be introduced by loading dynamic libraries. This can be done
- by passing ``-DLLVM_BUILD_STATIC=ON`` to cmake.
+ by passing ``-DLLVM_BUILD_STATIC=ON`` to CMake.
-* Try to avoid storage. On some systems you can use tmpfs. Putting the
+* Try to avoid storage. On some systems, you can use tmpfs. Putting the
program, inputs and outputs on tmpfs avoids touching a real storage
system, which can have a pretty big variability.
- To mount it (on linux and freebsd at least)::
+ To mount it (on Linux and FreeBSD at least)::
mount -t tmpfs -o size=<XX>g none dir_to_mount
@@ -52,7 +52,7 @@ Linux
echo performance > $i
done
-* Use https://github.com/lpechacek/cpuset to reserve cpus for just the
+* Use https://github.com/lpechacek/cpuset to reserve CPU cores for just the
program you are benchmarking. If using perf, leave at least 2 cores
so that perf runs in one and your program in another::
@@ -73,7 +73,7 @@ Linux
cset shield --exec -- perf stat -r 10 <cmd>
- This will run the command after ``--`` in the isolated cpus. The
+ This will run the command after ``--`` in the isolated CPU cores. The
particular perf command runs the ``<cmd>`` 10 times and reports
statistics.
@@ -82,6 +82,6 @@ With these in place you can expect perf variations of less than 0.1%.
Linux Intel
-----------
-* Disable turbo mode::
+* Disable Turbo Boost::
echo 1 > /sys/devices/system/cpu/intel_pstate/no_turbo
More information about the llvm-commits
mailing list