Re: [PATCH 2/8] scripts/mksysmap: remove comments described in nm(1)

From: Nick Desaulniers
Date: Fri Apr 07 2023 - 14:47:49 EST


On Wed, Mar 8, 2023 at 3:52 AM Masahiro Yamada <masahiroy@xxxxxxxxxx> wrote:
>
> I do not think we need to repeat what is written in 'man nm'.

I agree, but the paragraphs following the one you removed refer to a,
U, N, w, T, t, and W now with no context that those are the nm
formats.

I'm ok with this patch, but please consider adding a sentence along
the lines of:

The following refers to the symbol type as per nm(1).

>
> Signed-off-by: Masahiro Yamada <masahiroy@xxxxxxxxxx>
> ---
>
> scripts/mksysmap | 19 -------------------
> 1 file changed, 19 deletions(-)
>
> diff --git a/scripts/mksysmap b/scripts/mksysmap
> index 16a08b8ef2f8..697fc6653953 100755
> --- a/scripts/mksysmap
> +++ b/scripts/mksysmap
> @@ -10,25 +10,6 @@
> #####
> # Generate System.map (actual filename passed as second argument)
>
> -# $NM produces the following output:
> -# f0081e80 T alloc_vfsmnt
> -
> -# The second row specify the type of the symbol:
> -# A = Absolute
> -# B = Uninitialised data (.bss)
> -# C = Common symbol
> -# D = Initialised data
> -# G = Initialised data for small objects
> -# I = Indirect reference to another symbol
> -# N = Debugging symbol
> -# R = Read only
> -# S = Uninitialised data for small objects
> -# T = Text code symbol
> -# U = Undefined symbol
> -# V = Weak symbol
> -# W = Weak symbol
> -# Corresponding small letters are local symbols
> -
> # For System.map filter away:
> # a - local absolute symbols
> # U - undefined global symbols
> --
> 2.34.1
>


--
Thanks,
~Nick Desaulniers