From 29f4fdc42db187300b208ba4310920bedb300a04 Mon Sep 17 00:00:00 2001 From: Andrew Burgess Date: Fri, 29 Apr 2016 13:22:51 +0100 Subject: [PATCH] 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. --- binutils/ChangeLog | 4 ++++ binutils/doc/binutils.texi | 11 ++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/binutils/ChangeLog b/binutils/ChangeLog index 89ebe1573ff..47014a3ee51 100644 --- a/binutils/ChangeLog +++ b/binutils/ChangeLog @@ -1,3 +1,7 @@ +2016-05-10 Andrew Burgess + + * doc/binutils.texi (nm): Update description of --size-sort. + 2016-05-09 Nick Clifton PR binutils/20063 diff --git a/binutils/doc/binutils.texi b/binutils/doc/binutils.texi index a60ab66ee08..29f682dcc8d 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 -- 2.30.2