From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f72.google.com (mail-pj1-f72.google.com [209.85.216.72]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id CF3043612F6 for ; Mon, 21 Sep 2026 05:07:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.72 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789967255; cv=none; b=iAhjm+4sfcK4g2HxCkkhh43FtsoCV2peZZzq41W+oZLUPAhEugDkKX7Z9KP9oe/AIx7Cr9jkSwTy1qaz5vwuNb7KcP/8BO21G0uXFI5EcyOVYltlL+jSSVgIwTMbhv/f5Oh5CaKupe6ACQ80SnlUJjbjSE6T+6HvqaZiXr3d+oY= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789967255; c=relaxed/simple; bh=I+/F6Lf272wJ/FSJ8JJf6FA0fzMKbbtKGOoiTg12V5M=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=EOtgTE3TLmjjd2R0+a9ZcC1jC50D7KUV5WLJjrMD3LUtytwWwPcivBAL5aXofoJ0If2MsCMaMPpj3ehzw2yjr9kxlYwQtmEzcPzE5Z1QBLtG2WMsXZMBzfOtNGOkQaeou/JQJa4Oe/OZBGVlAzlces/Erhhxbz672a8moI19cqo= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=QJf1WABg; arc=none smtp.client-ip=209.85.216.72 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="QJf1WABg" Received: by mail-pj1-f72.google.com with SMTP id 98e67ed59e1d1-398dcfabbf8so9473209a91.0 for ; Sun, 20 Sep 2026 22:07:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1789967253; x=1790572053; darn=vger.kernel.org; h=content-type:cc:to:from:subject:message-id:references:mime-version :in-reply-to:date:from:to:cc:subject:date:message-id:reply-to :content-type; bh=CsSfIgYZYlBwQ/QFRNukihIBFvet4HE3Ok6+/k+W1p0=; b=QJf1WABgqbukXBtIBIdoBb8CB8d9jjSuAwJqlFjXzGoAs2MNj79iPTzttnVFybBARX ImzSRQgL5g1iKRsw5pw8ezUYB/JT8TeXelDe0OWCV+JIbZIALrlVUwG0StA7mp3BPQvx RJeZJayWxF2C9l6fZEBluWwn4JfwxUHslSpzsnOuo4DUg5I5hmUHyYXUnKyDnGMHpA+k YOuPKu20FNnyv3BxGSGhbgI/Gr5XIk8FWMmaIt9trwsXhDIonr4fVMCbn6Z6vTMMfRAz nhD6Wlb+etSVbKgDOwOL0oWkIOpKt0+OmoCvuv8/Y+NAoGFHlLk63SjDE0TdyPqkBHlS kX5A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1789967253; x=1790572053; h=content-type:cc:to:from:subject:message-id:references:mime-version :in-reply-to:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to:content-type; bh=CsSfIgYZYlBwQ/QFRNukihIBFvet4HE3Ok6+/k+W1p0=; b=1ew0de08AkCHQTqsFR1MvbXC4lbx7JRcx6ShwWmuyYwgd5sFHiIQP1VIZO4pI2YWhV pUtEAicByi6gRL5w2IU1ueNLXwy1JC9Wk03FvQY74L91NG5YRzYFNUZn7gdkrTx86Aan cZdbFbMry1RfOJYU0aWUk44CAOJiyq/XbWETI2Pvyn7o6+xuRNxTImWPVtoO4tULZUzf Oyjtvxw0ZmoMBW4WUo9uTGNmV9WDOJiw0ql8kw0nnmpMIlQDZ26YOrIgtWvcJGP8ePnj MfUddayzoCZ+6VUDkY+p1i7DThJ/FccPyACD4ny7ov0EHARaGn46Oc9wudIaG/53g8VR 6kUQ== X-Forwarded-Encrypted: i=1; AKwUvBxZ98vQhu+WiRVv+cE2kzRY/XiHbqbYGQ25oaFfDjXz3vI3jAixV4lCCiaiYh8+0rnGjQoP/H0zLsT+3CBg6tqP@vger.kernel.org X-Gm-Message-State: AFuF++k73hkqig/lk8f1ZRhVNFOZrMdwuCupHCpdnnoyacMS7osqGJx8 rhgPw7cTGOciyiKU7k/Q29F9zdAZn1kMTTISi+p5c2+zTk1j+c/4qWVj6ADpJRNGHqYcr/MhHDH 5aKBduJi4NA== X-Received: from dlbro10.prod.google.com ([2002:a05:7022:158a:b0:143:91fd:56cb]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a17:90a:e7cd:b0:395:7fff:a08f with SMTP id 98e67ed59e1d1-39e549bd704mr15056170a91.0.1789967253026; Sun, 20 Sep 2026 22:07:33 -0700 (PDT) Date: Sun, 20 Sep 2026 22:06:25 -0700 In-Reply-To: Precedence: bulk X-Mailing-List: linux-perf-users@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: X-Mailer: git-send-email 2.55.0.1082.g2b9226bbc0-goog Message-ID: <1b18a2dd4cf8d4dd3af7cf61d841c59e75c07ade.1789966896.git.irogers@google.com> Subject: [PATCH v2 07/49] perf python: Improve perf script -l descriptions From: Ian Rogers To: irogers@google.com, acme@kernel.org, alice.mei.rogers@gmail.com, linux-perf-users@vger.kernel.org, namhyung@kernel.org Cc: adrian.hunter@intel.com, dapeng1.mi@linux.intel.com, james.clark@linaro.org, leo.yan@linux.dev, linux-kernel@vger.kernel.org, mingo@redhat.com, peterz@infradead.org, tmricht@linux.ibm.com Content-Type: text/plain; charset="UTF-8" Add module docstrings to counting.py, tracepoint.py, and twatch.py so that 'perf script -l' displays concise descriptions for all available standalone scripts: ``` $ perf script -l List of available scripts: ... counting Example for counting perf events. ... tracepoint Example showing how to enable a tracepoint and access its fields. twatch Example to show how to enable a software event and track context switches. ... ``` Signed-off-by: Ian Rogers --- tools/perf/python/counting.py | 1 + tools/perf/python/tracepoint.py | 1 + tools/perf/python/twatch.py | 1 + 3 files changed, 3 insertions(+) diff --git a/tools/perf/python/counting.py b/tools/perf/python/counting.py index 02121d2bb11d..9adbbeccdacd 100755 --- a/tools/perf/python/counting.py +++ b/tools/perf/python/counting.py @@ -1,5 +1,6 @@ #!/usr/bin/env python3 # SPDX-License-Identifier: GPL-2.0 +"""Example for counting perf events.""" # -*- python -*- # -*- coding: utf-8 -*- diff --git a/tools/perf/python/tracepoint.py b/tools/perf/python/tracepoint.py index 9d49a25b3b1e..faa5311b8418 100755 --- a/tools/perf/python/tracepoint.py +++ b/tools/perf/python/tracepoint.py @@ -1,5 +1,6 @@ #! /usr/bin/env python # SPDX-License-Identifier: GPL-2.0 +"""Example showing how to enable a tracepoint and access its fields.""" # -*- python -*- # -*- coding: utf-8 -*- diff --git a/tools/perf/python/twatch.py b/tools/perf/python/twatch.py index ad35b1620781..b0f1bf113162 100755 --- a/tools/perf/python/twatch.py +++ b/tools/perf/python/twatch.py @@ -1,5 +1,6 @@ #! /usr/bin/env python # SPDX-License-Identifier: GPL-2.0-only +"""Example to show how to enable a software event and track context switches.""" # -*- python -*- # -*- coding: utf-8 -*- # twatch - Experimental use of the perf python interface -- 2.55.0.1082.g2b9226bbc0-goog