Message ID | 20221115212546.7154-1-cyan@0x00a1e9.dev |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp2949344wru; Tue, 15 Nov 2022 13:29:48 -0800 (PST) X-Google-Smtp-Source: AA0mqf5w7VpjcanB7WGBz3OFfF4KFBPWBqBsZZUUdvp8kLlO2MvHNadMmNc1oivszLPlcYMBGxFB X-Received: by 2002:a17:906:36d2:b0:79e:5ea1:4f83 with SMTP id b18-20020a17090636d200b0079e5ea14f83mr14820367ejc.372.1668547788226; Tue, 15 Nov 2022 13:29:48 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668547788; cv=none; d=google.com; s=arc-20160816; b=0MW9vnCzWa5C2exin0ruc1my7/+4QADqoFBmo/Tz0VR3Gn8FLaaZfRM5IOmEvdF14O hx/I4xCA6qCZ4ML5eAIjiyT0UFcWFuIdp42MbHfCOae3EFKdi1cDkpaObz9d/hmgFWbb QBL/bJjYpfne/dX/oqaRutBw6jr8oh2+FmUzfx+LLrIokZ/8LuU18A2CXh7a+20FyQzR 6EMa+f8LgEE6xfHQ9vl/fJpmzzjG5THPklJdwd/IUWkrAV55+rP661e3W8uXOluqOICl GR0U7oHasDrgX5HAeEkn1rlagH9xXwaB29w0/xHfH7crOKNfGlTc83G3MDyEW3BXsATM Y86w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:message-id:date:subject:cc:to:from :dkim-signature; bh=5crKBJk5pAZYUIKM6y7Y1WfvEopprUvgi5Bt8JeCxg8=; b=wR1y0UifNqtp+IUFHRp3S/SqB+nRyed0fGoEIla5gwMODxjpJF4yw1PyVrJnpUGhI2 ZODTWstoMUsrwiFiw7gl6riMVbq2MpufnfkwBwiOJQzmBWxEnu2dBbI+9qdS4x3be/N7 o4HNbki6ID2roG80PSW1gMx7Ype5LVkNTTYdAJfNJ9VpACRe+dRFwY78P7+wEX/75kr6 Lrwyx0rZDQD9KrVOMJQsh4QCg2zDC5a0rNgX3eO4E4kQEF685Qv4Iz2w3pUm64uUYDtD ITWlM9fr/cmDWCUIJH/o+RBkJnvdtFP2NyUxoGGkAWJPFckLIoJFXFB0mvbqtbnoumXy HDIw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@0x00a1e9-dev.20210112.gappssmtp.com header.s=20210112 header.b="oCrbN/Xw"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id xa6-20020a170906fd8600b00778d193ca81si12689047ejb.550.2022.11.15.13.29.04; Tue, 15 Nov 2022 13:29:48 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@0x00a1e9-dev.20210112.gappssmtp.com header.s=20210112 header.b="oCrbN/Xw"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231356AbiKOV0R (ORCPT <rfc822;maxim.cournoyer@gmail.com> + 99 others); Tue, 15 Nov 2022 16:26:17 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48772 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230215AbiKOV0C (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Tue, 15 Nov 2022 16:26:02 -0500 Received: from mail-pl1-x634.google.com (mail-pl1-x634.google.com [IPv6:2607:f8b0:4864:20::634]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9E1F26169 for <linux-kernel@vger.kernel.org>; Tue, 15 Nov 2022 13:26:00 -0800 (PST) Received: by mail-pl1-x634.google.com with SMTP id b21so14446322plc.9 for <linux-kernel@vger.kernel.org>; Tue, 15 Nov 2022 13:26:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=0x00a1e9-dev.20210112.gappssmtp.com; s=20210112; h=message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=5crKBJk5pAZYUIKM6y7Y1WfvEopprUvgi5Bt8JeCxg8=; b=oCrbN/XwA+N17HuCDVu3PdusMxtiNhMj/egsHBwCL/VeGA3VvuQEDmMEQ6byFzNprw ZZ2B2xg4AYUeyxFTK0ar3uEccZUOr02xp5biAzA0J/y0PhsGlSY2ubkUSBDS3yl2bFkK FlJA52RjwHdVbcN0QijmjBP0KEF+3hjcwO6Z5NolFPlWHiuSKNSgXRsuFbc/6rDtHLBN IqfDzhgt1DNpNXBM1aj3eE0P22CiYyXFP+LYR7sulqSs8ENjUF+O6mSqBU+2uEj8Rhuq WKFinLvf0bM+/qzuvJSBmhRy2/x1obbi3lqug23xxYbAzRbqQxpiUmyWZ6KuUYCHffUy jIHg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=5crKBJk5pAZYUIKM6y7Y1WfvEopprUvgi5Bt8JeCxg8=; b=n9FvmJqNFLBSO2IERdqt212Uq3+uJhCGx0RcHKQgLViBS507zw5d9nw02KwcZVXlH5 WuDLMj9HUrzwlME16VmCXjHhiR84bgxhzLxletvbG1PwFJ01Ir2PLXFNsDqzyn8aMdhF tvqnYciKdrJrysnasdD4fmPa1GGBhD7l6x6+nFAO6yPLNgBiqbufkwg3htDtJq3EwBJ4 Oz8OciLLukOeiWRpdlqxV+qhW7BQfzXbrGFuWCneeuZtshlV4j23pw05TomvZ9pzlFs1 WHFSPDRGDdnvVHzS6VSXn9ddjPlmFmAadXs5XyuC2V2KC81saQpDmMj6fMaF3LxZdddZ JefQ== X-Gm-Message-State: ANoB5pnqXo6c61HwIPR4NkHicbPTb0ZgzWuouQucLf5US8cyvOFrRuLa B+WHnIN9UJ1Y3QxR6MxTDJdczObnNtpErPBq X-Received: by 2002:a17:903:1109:b0:17d:839:5a17 with SMTP id n9-20020a170903110900b0017d08395a17mr5957015plh.62.1668547559878; Tue, 15 Nov 2022 13:25:59 -0800 (PST) Received: from 0x00a1e9.dev ([2001:200:0:8802:ff5b:df6b:bf6c:21ba]) by smtp.gmail.com with ESMTPSA id q7-20020aa78427000000b0056baca45977sm9245389pfn.21.2022.11.15.13.25.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Nov 2022 13:25:59 -0800 (PST) From: Yuma Ueda <cyan@0x00a1e9.dev> To: linux-kernel@vger.kernel.org Cc: keescook@chromium.org, gregkh@linuxfoundation.org, ojeda@kernel.org, boqun.feng@gmail.com, masahiroy@kernel.org, samitolvanen@google.com, ytcoode@gmail.com, Yuma Ueda <cyan@0x00a1e9.dev> Subject: [PATCH v2] scripts/kallsyms.c Make the comment up-to-date with current implementation Date: Wed, 16 Nov 2022 06:25:46 +0900 Message-Id: <20221115212546.7154-1-cyan@0x00a1e9.dev> X-Mailer: git-send-email 2.17.1 X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1749598765960331032?= X-GMAIL-MSGID: =?utf-8?q?1749599165612941524?= |
Series |
[v2] scripts/kallsyms.c Make the comment up-to-date with current implementation
|
|
Commit Message
Yuma Ueda
Nov. 15, 2022, 9:25 p.m. UTC
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(-)
Comments
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
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
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