fixup! Use a shorter flag name

Author: mshockwave

llvm/docs/CommandGuide/llvm-exegesis.rst

@@ -299,18 +299,25 @@ OPTIONS
   However, it is possible to stop at some stage before measuring. Choices are:
   * ``prepare-snippet``: Only generate the minimal instruction sequence.
   * ``prepare-and-assemble-snippet``: Same as ``prepare-snippet``, but also dumps an excerpt of the sequence (hex encoded).
-  * ``assemble-measured-code``: Same as ``prepare-and-assemble-snippet``. but
-    also creates the full sequence that can be dumped to a file using ``--dump-object-to-disk``.
-    If either zlib or zstd is available and we're using either duplicate or
-    loop repetition mode, this phase generates benchmarks with a serialized
-    snippet object file attached to it.
+  * ``assemble-measured-code``: Same as ``prepare-and-assemble-snippet``. but also creates the full sequence that can be dumped to a file using ``--dump-object-to-disk``.
   * ``measure``: Same as ``assemble-measured-code``, but also runs the measurement.
   * ``dry-run-measurement``: Same as measure, but does not actually execute the snippet.
 
+.. option:: --serialize-benchmarks
+
+  Generate a fully serialized benchmarks file, including the assembled object
+  files. This is useful to resume the measurement later with ``--run-measurement``.
+
+.. option:: --force-serialized-obj-compress-format=[zlib|zstd]
+
+  When serializing benchmarks with ``--serialize-benchmarks``, always use the
+  compression format designated by this flag.
+
 .. option:: --run-measurement=<benchmarks file>
 
-  Given a benchmarks file generated after the ``assembly-measured-code`` phase,
-  resume the measurement phase from it.
+  Given a fully serialized benchmarks file generated after the
+  ``assembly-measured-code`` phase with ``--serialize-benchmarks``, resume the
+  measurement phase from it.
 
 .. option:: --x86-lbr-sample-period=<nBranches/sample>
 

llvm/test/tools/llvm-exegesis/serialize-obj-file.test

@@ -1,4 +1,4 @@
-# RUN: llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --exegesis-serialize-benchmarks --benchmark-phase=assemble-measured-code \
+# RUN: llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --serialize-benchmarks --benchmark-phase=assemble-measured-code \
 # RUN:    --mode=latency --benchmarks-file=%t.yaml
 # RUN: FileCheck --input-file=%t.yaml %s --check-prefixes=CHECK,SERIALIZE
 # RUN: llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --run-measurement=%t.yaml --mode=latency --benchmark-phase=dry-run-measurement --use-dummy-perf-counters \
@@ -10,11 +10,11 @@
 # RUN:    FileCheck %s --check-prefix=NO-SERIALIZE
 
 # We currently don't support serialization for repetition modes that require more than one snippets.
-# RUN: not llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --mode=latency --exegesis-serialize-benchmarks --benchmark-phase=assemble-measured-code \
+# RUN: not llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --mode=latency --serialize-benchmarks --benchmark-phase=assemble-measured-code \
 # RUN:    --repetition-mode=min 2>&1 | FileCheck %s --check-prefix=NOT-SUPPORTED
-# RUN: not llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --mode=latency --exegesis-serialize-benchmarks --benchmark-phase=assemble-measured-code \
+# RUN: not llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --mode=latency --serialize-benchmarks --benchmark-phase=assemble-measured-code \
 # RUN:    --repetition-mode=middle-half-loop 2>&1 | FileCheck %s --check-prefix=NOT-SUPPORTED
-# RUN: not llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --mode=latency --exegesis-serialize-benchmarks --benchmark-phase=assemble-measured-code \
+# RUN: not llvm-exegesis -mtriple=riscv64 -mcpu=sifive-p470 --opcode-name=SH3ADD --mode=latency --serialize-benchmarks --benchmark-phase=assemble-measured-code \
 # RUN:    --repetition-mode=middle-half-duplicate 2>&1 | FileCheck %s --check-prefix=NOT-SUPPORTED
 
 # REQUIRES: riscv-registered-target && native-registered-exegesis-target
@@ -37,5 +37,5 @@
 
 # Negative tests.
 
-# NOT-SUPPORTED: -exegesis-serialize-benchmarks currently only supports -repetition-mode of loop and duplicate.
+# NOT-SUPPORTED: -serialize-benchmarks currently only supports -repetition-mode of loop and duplicate.
 # NO-SERIALIZE-NOT: object_file:

llvm/tools/llvm-exegesis/lib/BenchmarkResult.cpp

@@ -31,8 +31,9 @@ static constexpr const char kInvalidOperand[] = "INVALID";
 namespace llvm {
 
 static cl::opt<compression::Format> ForceObjectFileCompressionFormat(
-    "exegesis-force-obj-compress-format", cl::Hidden,
-    cl::desc("Force to use this compression format for object files."),
+    "force-serialized-obj-compress-format", cl::Hidden,
+    cl::desc(
+        "Force to use this compression format for serialized object files."),
     cl::values(clEnumValN(compression::Format::Zstd, "zstd", "Using Zstandard"),
                clEnumValN(compression::Format::Zlib, "zlib", "Using LibZ")));
 

llvm/tools/llvm-exegesis/lib/BenchmarkRunner.cpp

@@ -54,7 +54,7 @@
 namespace llvm {
 
 static cl::opt<bool>
-    SerializeBenchmarks("exegesis-serialize-benchmarks",
+    SerializeBenchmarks("serialize-benchmarks",
                         cl::desc("Generate fully-serialized benchmarks "
                                  "that can later be deserialized and "
                                  "resuming the measurement."),
@@ -679,8 +679,8 @@ BenchmarkRunner::getRunnableConfiguration(
       if (RepetitionMode != Benchmark::Loop &&
           RepetitionMode != Benchmark::Duplicate)
         return make_error<Failure>(
-            "-exegesis-serialize-benchmarks currently "
-            "only supports -repetition-mode of loop and duplicate.");
+            "-serialize-benchmarks currently only supports -repetition-mode "
+            "of loop and duplicate.");
 
       if (Error E = BenchmarkResult.setObjectFile(*Snippet))
         return std::move(E);