[PATCH v3] scripts/kallsyms.c Make the comment up-to-date with current implementation

[PATCH v3] scripts/kallsyms.c Make the comment up-to-date with current implementation

[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 equivalent to what the usage() function prints.

Signed-off-by: Yuma Ueda <cyan@0x00a1e9.dev>
---
 Changes from V2:
  - tabs in the comment into spaces
  - `scripts/kallsyms` in the comment into `kallsyms`

 Changes from V1:
  - Fix typo

 scripts/kallsyms.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/scripts/kallsyms.c b/scripts/kallsyms.c
index 03fa07ad45d9..46d1afaaf4cd 100644
--- a/scripts/kallsyms.c
+++ b/scripts/kallsyms.c
@@ -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: 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
-- 
2.17.1

Re: [PATCH v3] scripts/kallsyms.c Make the comment up-to-date with current implementation

[Miguel Ojeda]

On Fri, Nov 18, 2022 at 2:36 PM Yuma Ueda <cyan@0x00a1e9.dev> wrote:
>
> The comment in scripts/kallsyms.c describing the usage of
> scripts/kallsyms does not reflect the latest implementation.
> Fix the comment to be equivalent to what the usage() function prints.

Not sure why you used that many leading spaces, but the content looks
fine to me!

Reviewed-by: Miguel Ojeda <ojeda@kernel.org>

Cheers,
Miguel