From: James Henderson <jh7370@my.bristol.ac.uk>
Date: Fri, 13 Sep 2019 15:01:39 +0000 (+0000)
Subject: [docs][llvm-readelf][llvm-readobj] Improve --stack-sizes documentation
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3e78f24a796ce1dbb0a18dbd5dea8a80ddd65369;p=llvm

[docs][llvm-readelf][llvm-readobj] Improve --stack-sizes documentation

llvm-readobj's document was missing --stack-sizes entirely from its
document, so this patch adds it. It also adds a note to the llvm-readelf
description that the switch is only implemented for GNU style output
currently. For reference, --stack-sizes was added in r367942.

Reviewed by: MaskRay

Differential Revision: https://reviews.llvm.org/D67548

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@371862 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/CommandGuide/llvm-readelf.rst b/docs/CommandGuide/llvm-readelf.rst
index ecdb8f80771..6aa90475572 100644
--- a/docs/CommandGuide/llvm-readelf.rst
+++ b/docs/CommandGuide/llvm-readelf.rst
@@ -163,7 +163,8 @@ OPTIONS
 .. option:: --stack-sizes
 
  Display the contents of the stack sizes section(s), i.e. pairs of function
- names and the size of their stack frames.
+ names and the size of their stack frames. Currently only implemented for GNU
+ style output.
 
 .. option:: --string-dump=<section[,section,...]>, -p
 
diff --git a/docs/CommandGuide/llvm-readobj.rst b/docs/CommandGuide/llvm-readobj.rst
index d15a6739b8d..30f7976183d 100644
--- a/docs/CommandGuide/llvm-readobj.rst
+++ b/docs/CommandGuide/llvm-readobj.rst
@@ -214,6 +214,12 @@ The following options are implemented only for the ELF file format.
 
  Display the section to segment mapping.
 
+.. option:: --stack-sizes
+
+ Display the contents of the stack sizes section(s), i.e. pairs of function
+ names and the size of their stack frames. Currently only implemented for GNU
+ style output.
+
 .. option:: --version-info, -V
 
  Display version sections.