Skip to contentSkip to conversation

scripts/kallsyms.c Make the comment up-to-date with current implementation

PATCH Superseded Yuma Ueda 2 participants 3 messages Nov 15, 2022 – Nov 18, 2022

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Yuma Ueda

author
#0 lore raw

PATCH v2 1/1 scripts/kallsyms.c Make the comment up-to-date with current implementation

The comment in scripts/kallsyms.c describing the usage of scripts/kallsyms does not reflect the latest implementation. Fix the comment to be up-to-date with the current implementation.

Changes from V1:
- Fix typo

---
 scripts/kallsyms.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
scripts/kallsyms.c +2 -1
index 03fa07ad45d9..05c99ca3847b 100644
@@ -5,7 +5,8 @@
  * This software may be used and distributed according to the terms
  * of the GNU General Public License, incorporated herein by reference.
  *
- * Usage: nm -n vmlinux | scripts/kallsyms [--all-symbols] > symbols.S
+ * Usage: scripts/kallsyms [--all-symbols] [--absolute-percpu]
+ * 			[--base-relative] in.map > out.S
  *
  *      Table compression uses all the unused char codes on the symbols and
  *  maps these to the most used substrings (tokens). For instance, it might
Signature · 1 line
2.17.1
#1 lore raw
Quoted 4 lines · Yuma Ueda

The comment in scripts/kallsyms.c describing the usage of scripts/kallsyms does not reflect the latest implementation. Fix the comment to be up-to-date with the current implementation.

It may be a good idea to say in the commit message that this is now equivalent to what the usage() function prints (and possibly change scripts/kallsyms to just kallsyms to make it exactly equal). In fact, we could replace the comment with "See usage() function" to avoid further desyncs... But that is a different patch :)

Also, I am not sure we want to use tabs on the comment -- the rest of it uses spaces.

Cheers,
Miguel

author
#2 lore raw

Thank you for your comment.

Quoted 9 lines · Miguel Ojeda
Quoted 4 lines · Yuma Ueda

The comment in scripts/kallsyms.c describing the usage of scripts/kallsyms does not reflect the latest implementation. Fix the comment to be up-to-date with the current implementation.

It may be a good idea to say in the commit message that this is now equivalent to what the usage() function prints (and possibly change scripts/kallsyms to just kallsyms to make it exactly equal).

I'll change it that way for both.

Quoted 3 lines

In fact, we could replace the comment with "See usage() function" to avoid further desyncs... But that is a different patch :)

I don't know if the comment should just be changed to "See usage() function", and as you said, that should be done in a different patch,
so for now I will send a patch that fixes the issues you mentioned.

Quoted 2 lines

Also, I am not sure we want to use tabs on the comment -- the rest of it uses spaces.

OK, I'll change tabs into spaces.

Quoted 3 lines

Cheers,
Miguel

I'll send a new version of the patch later.

Regards,

Yuma Ueda