[llvm] [NFC][llvm][docs] Fix alphabetical order of commands (PR #176280)

Prabhu Rajasekaran via llvm-commits llvm-commits at lists.llvm.org
Thu Jan 15 16:25:37 PST 2026


https://github.com/Prabhuk created https://github.com/llvm/llvm-project/pull/176280

Fix the order of commands for llvm-readelf and llvm-readobj docs.


>From f3a7128a4a507d3a530e0c88af791d2083526a2f Mon Sep 17 00:00:00 2001
From: prabhukr <prabhukr at google.com>
Date: Fri, 16 Jan 2026 00:23:47 +0000
Subject: [PATCH] [NFC][llvm][docs] Fix alphabetical order of commands

Fix the order of commands for llvm-readelf and llvm-readobj docs.
---
 llvm/docs/CommandGuide/llvm-readelf.rst |  8 +++---
 llvm/docs/CommandGuide/llvm-readobj.rst | 36 ++++++++++++-------------
 2 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/llvm/docs/CommandGuide/llvm-readelf.rst b/llvm/docs/CommandGuide/llvm-readelf.rst
index 5403fea60d5ee..5fd635778b63c 100644
--- a/llvm/docs/CommandGuide/llvm-readelf.rst
+++ b/llvm/docs/CommandGuide/llvm-readelf.rst
@@ -38,6 +38,10 @@ OPTIONS
  Display the contents of the basic block address map section(s), which contain the
  address of each function, along with the relative offset of each basic block.
 
+.. option:: --cg-profile
+
+ Display the callgraph profile section.
+
 .. option:: --decompress, -z
 
   Dump decompressed section content when used with ``-x`` or ``-p``.
@@ -63,10 +67,6 @@ OPTIONS
 
  Display the dynamic table.
 
-.. option:: --cg-profile
-
- Display the callgraph profile section.
-
 .. option:: --histogram, -I
 
  Display a bucket list histogram for dynamic symbol hash tables.
diff --git a/llvm/docs/CommandGuide/llvm-readobj.rst b/llvm/docs/CommandGuide/llvm-readobj.rst
index 0d05b947a6b3e..f3afd9c7c9648 100644
--- a/llvm/docs/CommandGuide/llvm-readobj.rst
+++ b/llvm/docs/CommandGuide/llvm-readobj.rst
@@ -181,13 +181,9 @@ The following options are implemented only for the ELF file format.
  When pgo analysis maps are present, all analyses are printed as their raw
  value.
 
-.. option:: --pretty-pgo-analysis-map
-
- When pgo analysis maps are present in the basic block address map section(s),
- analyses with special formats (i.e. BlockFrequency, BranchProbability, etc)
- are printed using the same format as their respective analysis pass.
+.. option:: --cg-profile
 
- Requires :option:`--bb-addr-map` to have an effect.
+ Display the callgraph profile section.
 
 .. option:: --dependent-libraries
 
@@ -205,14 +201,6 @@ The following options are implemented only for the ELF file format.
 
  Display the dynamic table.
 
-.. option:: --cg-profile
-
- Display the callgraph profile section.
-
-.. option:: --histogram, -I
-
- Display a bucket list histogram for dynamic symbol hash tables.
-
 .. option:: --elf-linker-options
 
  Display the linker options section.
@@ -224,10 +212,6 @@ The following options are implemented only for the ELF file format.
  structured format. ``GNU`` output mimics the equivalent GNU :program:`readelf`
  output. ``JSON`` is JSON formatted output intended for machine consumption.
 
-.. option:: --section-groups, -g
-
- Display section groups.
-
 .. option:: --gnu-hash-table
 
  Display the GNU hash table for dynamic symbols.
@@ -240,6 +224,10 @@ The following options are implemented only for the ELF file format.
 
  Display the hash table for dynamic symbols.
 
+.. option:: --histogram, -I
+
+ Display a bucket list histogram for dynamic symbol hash tables.
+
 .. option:: --memtag
 
  Display information about memory tagging present in the binary. This includes
@@ -250,6 +238,14 @@ The following options are implemented only for the ELF file format.
 
  Display all notes.
 
+.. option:: --pretty-pgo-analysis-map
+
+ When pgo analysis maps are present in the basic block address map section(s),
+ analyses with special formats (i.e. BlockFrequency, BranchProbability, etc)
+ are printed using the same format as their respective analysis pass.
+
+ Requires :option:`--bb-addr-map` to have an effect.
+
 .. option:: --pretty-print
 
  When used with :option:`--elf-output-style`, JSON output will be formatted in
@@ -259,6 +255,10 @@ The following options are implemented only for the ELF file format.
 
  Display the program headers.
 
+.. option:: --section-groups, -g
+
+ Display section groups.
+
 .. option:: --section-mapping
 
  Display the section to segment mapping.



More information about the llvm-commits mailing list