summaryrefslogtreecommitdiff
path: root/binutils/doc
diff options
context:
space:
mode:
authorAndrew Burgess <andrew.burgess@embecosm.com>2016-04-29 13:22:51 +0100
committerAndrew Burgess <andrew.burgess@embecosm.com>2016-05-10 08:47:14 +0100
commit29f4fdc42db187300b208ba4310920bedb300a04 (patch)
tree7be9b2b9356df0ae455e6bd71a84a44a2c98c5bb /binutils/doc
parentd63a50b79e50b9a48570a9d9fdb86d7c692f3c18 (diff)
binutils/doc: Update documentation for nm --size-sort
The documentation for 'nm --size-sort' is out of step with the code, the special handling for ELF is not mentioned in the documentation, and could cause confusion to a user. binutils/ChangeLog: * doc/binutils.texi (nm): Update description of --size-sort.
Diffstat (limited to 'binutils/doc')
-rw-r--r--binutils/doc/binutils.texi11
1 files changed, 6 insertions, 5 deletions
diff --git a/binutils/doc/binutils.texi b/binutils/doc/binutils.texi
index a60ab66ee0..29f682dcc8 100644
--- a/binutils/doc/binutils.texi
+++ b/binutils/doc/binutils.texi
@@ -1012,11 +1012,12 @@ types. This option is only available if the toolchain has been built
with plugin support enabled.
@item --size-sort
-Sort symbols by size. The size is computed as the difference between
-the value of the symbol and the value of the symbol with the next higher
-value. If the @code{bsd} output format is used the size of the symbol
-is printed, rather than the value, and @samp{-S} must be used in order
-both size and value to be printed.
+Sort symbols by size. For ELF objects symbol sizes are read from the
+ELF, for other object types the symbol sizes are computed as the
+difference between the value of the symbol and the value of the symbol
+with the next higher value. If the @code{bsd} output format is used
+the size of the symbol is printed, rather than the value, and
+@samp{-S} must be used in order both size and value to be printed.
@item --special-syms
Display symbols which have a target-specific special meaning. These