* [PATCH v2] scripts/kallsyms.c Make the comment up-to-date with current implementation
@ 2022-11-15 21:25 Yuma Ueda
2022-11-16 20:04 ` Miguel Ojeda
0 siblings, 1 reply; 3+ messages in thread
From: Yuma Ueda @ 2022-11-15 21:25 UTC (permalink / raw)
To: linux-kernel
Cc: keescook, gregkh, ojeda, boqun.feng, masahiroy, samitolvanen,
ytcoode, 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.
Changes from V1:
- Fix typo
Signed-off-by: Yuma Ueda <cyan@0x00a1e9.dev>
---
scripts/kallsyms.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/scripts/kallsyms.c b/scripts/kallsyms.c
index 03fa07ad45d9..05c99ca3847b 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: 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
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] scripts/kallsyms.c Make the comment up-to-date with current implementation
2022-11-15 21:25 [PATCH v2] scripts/kallsyms.c Make the comment up-to-date with current implementation Yuma Ueda
@ 2022-11-16 20:04 ` Miguel Ojeda
2022-11-18 13:27 ` Yuma Ueda
0 siblings, 1 reply; 3+ messages in thread
From: Miguel Ojeda @ 2022-11-16 20:04 UTC (permalink / raw)
To: Yuma Ueda
Cc: linux-kernel, keescook, gregkh, ojeda, boqun.feng, masahiroy,
samitolvanen, ytcoode
On Tue, Nov 15, 2022 at 10:26 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 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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v2] scripts/kallsyms.c Make the comment up-to-date with current implementation
2022-11-16 20:04 ` Miguel Ojeda
@ 2022-11-18 13:27 ` Yuma Ueda
0 siblings, 0 replies; 3+ messages in thread
From: Yuma Ueda @ 2022-11-18 13:27 UTC (permalink / raw)
To: Miguel Ojeda
Cc: linux-kernel, keescook, gregkh, ojeda, boqun.feng, masahiroy,
samitolvanen, ytcoode
Thank you for your comment.
On Wed, Nov 16, 2022 at 09:04:22PM +0100, Miguel Ojeda wrote:
> On Tue, Nov 15, 2022 at 10:26 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 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.
> 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.
> 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.
>
> Cheers,
> Miguel
I'll send a new version of the patch later.
Regards,
Yuma Ueda
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-11-18 13:27 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-15 21:25 [PATCH v2] scripts/kallsyms.c Make the comment up-to-date with current implementation Yuma Ueda
2022-11-16 20:04 ` Miguel Ojeda
2022-11-18 13:27 ` Yuma Ueda
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.