From nobody Fri Dec 19 13:47:14 2025 Received: from mail-pl1-f176.google.com (mail-pl1-f176.google.com [209.85.214.176]) (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 8C57F1FDA89 for ; Mon, 13 Oct 2025 09:27:47 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1760347670; cv=none; b=mZx4LO7qCzjFFy9sCOMLLm3qal6ecYM5MNhAPfP9QYVXmgEJDDLCdHl7hP9OVUmhS5AlCaCjdNNN8acCBwU8z233rjHN+atMfu9v+p2NmY91DqTt9h0zViFKMYeXGPBdhS04aTFTTm3mxEjSYaadw35sRnYWUVF1EOUSOYEhFSk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1760347670; c=relaxed/simple; bh=0so9Nv2w1Nst29QNWmqGECw2nex+MrB15ihNyBFUgkI=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=WzMyTF6hICFUYcplRTxhW7f8F5SoW9q1odcrMPr7/zY85yJT0+FunlsXSj7VJV5nCTbC6QR/GFJ/FdO0Df0/qex+c6VlWDgh1iYeiQ8cyaA3+N6fbQF98cYtYtrcDsfeZCc4o/fCG45CBNPFNdjbQx+3xFoJ4N1e9V9TZubzr3c= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=VdUyppxd; arc=none smtp.client-ip=209.85.214.176 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="VdUyppxd" Received: by mail-pl1-f176.google.com with SMTP id d9443c01a7336-273a0aeed57so60781715ad.1 for ; Mon, 13 Oct 2025 02:27:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1760347667; x=1760952467; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=33Yue8BtCN77Y+mpJdjQyPFAqeEOnq6m8WWwr+VUWDQ=; b=VdUyppxd09r+n+zqg1ksN4uUZSdzc0JuXPPTTVxWDhmp6RPrmifPzON60FJ60Yp+KQ Qz2+V1d9qA9ROUM4KCsNyyc4vRN2tuFgpnEExd2Wl6vhVyU2R/88FyuxtBoJjI0a9Xuc 95vVibctTcZi5e/T4J7AxAbKimHcQZZAQaAb7PYZBquFfkpYqnmYjwlWotR+L9r9tMdm cKplSHyrIb3CfxiUCrmEVEeh/qXrpQBxCTbySqdylh2CvgEj7E+/ot5JCONCkP2CWk0q vckBhzAMF8pOHe/blYshEHHIJh6ftnzjdf0Hcb7BVAUCmlzrX3Spglzy/IdzZQB7tofb UzMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1760347667; x=1760952467; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=33Yue8BtCN77Y+mpJdjQyPFAqeEOnq6m8WWwr+VUWDQ=; b=XU46n73FTHfKtjPU6OOtznFHdCSUSr0V7WjzZt2/UERNhvgclxY4WssAHFvLfDWfkx mvnU7m69+jiKyDaE1EbTAzD46yNFomLGzKvhsZlLGjHPJ4ME972A+tCb6QkSd/OGd5re WB6XDsYwbEdzPC2u8/dBiM4+vcW8ls2KEacp008pwiy7F5oMqgTBu9jaqRyBjHtSJbdV otoPh8ymIb0Tfvz96G6Dm23/96rwLi/UjRFnZBbAtBsDDZcbLlyNodgNR0LfNItDsf8+ xTLKkz01AmFqQ6QK+ES/gzVEWxogTWIEcQhPtQpAgTwk9rpZbF6fcrzVeipQT5uC9eDt VCMA== X-Gm-Message-State: AOJu0YwfvFJubVdKWAQf+p8j3OcpUtMdyfYBFb2A9qcjKkVmYkHJfgO9 iijDEFKUX6QJCrne3qMjviAfTkvazKTbV9qaMb3Hg9zRMqsR7vDVQ19Y X-Gm-Gg: ASbGncuUBx0m+TmZX3BqD6PmFGyh4IipgYJ/T6NNVhF3fxcbWNm9YVu9vCYZ/2z4DCJ EDUZUcUDFGJRbf84cad8+LyFPCt5B4zl5pgOy+c7fQmTXgmXtPcnE5x7Q4OC8R0Bk3BDbwWmKL5 OlAFiqrzJ9pUG2khVBA+42himFgjKlt4Mfim20T4HetIRS486UGkIKmYArYwYU+rRFWhNKLZEuB zrp2/8sbOvqMa8hLqcXyAaGG1J1cWRdD3dnN9RqlcqOS8v9u5/UgqqJoA+USYAqFCil8gaiNnBp 2KR1Ss3fGdWj6tDSllRrKoZdqlnCiekCDMy9a4FwFbMThk0HsRRhNUZvN6BR+esBqBkw4zJ1bBE u0jolw9ETzIJeBPeH2Vxgsu5OMCOmrp9bedBEczTKA4+D X-Google-Smtp-Source: AGHT+IEVOVjuVmGlAswunThnXgHEbstlR3zgA2EaNSi9B1tFIwcbWkyGD5c8pcJmY6UIxDqFiEkzGg== X-Received: by 2002:a17:903:298c:b0:267:9601:dca0 with SMTP id d9443c01a7336-29027f3b996mr240561515ad.27.1760347666660; Mon, 13 Oct 2025 02:27:46 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-29034de658bsm128507125ad.22.2025.10.13.02.27.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Oct 2025 02:27:45 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id B1BED409E678; Mon, 13 Oct 2025 16:27:43 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux Kernel Tracing Cc: Daniel Bristot de Oliveira , Steven Rostedt , Jonathan Corbet , Tomas Glozar , Crystal Wood , Bagas Sanjaya , Gopi Krishna Menon Subject: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt Date: Mon, 13 Oct 2025 16:27:20 +0700 Message-ID: <20251013092719.30780-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=13395; i=bagasdotme@gmail.com; h=from:subject; bh=gSBGOKA6gSHb608cBgAu3Jqy0KbAHZwaPbwuL+Hj0/w=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBlvjk6suDiN48ZH7TirrMXr/T6fL3l0kvPeNSEO3o/z8 pZEnJod31HKwiDGxSArpsgyKZGv6fQuI5EL7WsdYeawMoEMYeDiFICJ3FFjZDj96cbnbW+Mpry1 Et/t7Lxvy51D7Stmb/x/TPLRpHUvZ4pPYfjDmenDKp//jeuz9NZdtV5nGd56zC1vazz2yHhP+he GZf84AQ== X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Gopi Krishna Menon Sphinx reports htmldocs errors: Documentation/tools/rtla/common_options.rst:58: ERROR: Undefined substituti= on referenced: "threshold". Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substituti= on referenced: "tool". Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substituti= on referenced: "thresharg". Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substituti= on referenced: "tracer". Documentation/tools/rtla/common_options.rst:92: ERROR: Undefined substituti= on referenced: "tracer". Documentation/tools/rtla/common_options.rst:98: ERROR: Undefined substituti= on referenced: "actionsperf". Documentation/tools/rtla/common_options.rst:113: ERROR: Undefined substitut= ion referenced: "tool". common_*.rst files are snippets that are intended to be included by rtla docs (rtla*.rst). common_options.rst in particular contains substitutions which depend on other common_* includes, so building it independently as reST source results in above errors. Rename all common_*.rst files to common_*.txt to prevent Sphinx from building these snippets as standalone reST source and update all include references accordingly. Link: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.ht= ml#substitutions Suggested-by: Tomas Glozar Suggested-by: Bagas Sanjaya Signed-off-by: Gopi Krishna Menon Reviewed-by: Tomas Glozar Fixes: 05b7e10687c6 ("tools/rtla: Add remaining support for osnoise actions= ") Reviewed-by: Bagas Sanjaya Link: https://lore.kernel.org/r/20251008184522.13201-1-krishnagopi487@gmail= .com [Bagas: massage commit message and apply trailers] Signed-off-by: Bagas Sanjaya Reviewed-by: Randy Dunlap Tested-by: Randy Dunlap --- This patch targets trace/fixes branch of linux-trace.git tree. .../{common_appendix.rst =3D> common_appendix.txt} | 0 ...mmon_hist_options.rst =3D> common_hist_options.txt} | 0 .../rtla/{common_options.rst =3D> common_options.txt} | 0 ...escription.rst =3D> common_osnoise_description.txt} | 0 ...snoise_options.rst =3D> common_osnoise_options.txt} | 0 ...common_timerlat_aa.rst =3D> common_timerlat_aa.txt} | 0 ...scription.rst =3D> common_timerlat_description.txt} | 0 ...erlat_options.rst =3D> common_timerlat_options.txt} | 0 ...common_top_options.rst =3D> common_top_options.txt} | 0 Documentation/tools/rtla/rtla-hwnoise.rst | 8 ++++---- Documentation/tools/rtla/rtla-osnoise-hist.rst | 10 +++++----- Documentation/tools/rtla/rtla-osnoise-top.rst | 10 +++++----- Documentation/tools/rtla/rtla-osnoise.rst | 4 ++-- Documentation/tools/rtla/rtla-timerlat-hist.rst | 12 ++++++------ Documentation/tools/rtla/rtla-timerlat-top.rst | 12 ++++++------ Documentation/tools/rtla/rtla-timerlat.rst | 4 ++-- Documentation/tools/rtla/rtla.rst | 2 +- 17 files changed, 31 insertions(+), 31 deletions(-) rename Documentation/tools/rtla/{common_appendix.rst =3D> common_appendix.= txt} (100%) rename Documentation/tools/rtla/{common_hist_options.rst =3D> common_hist_= options.txt} (100%) rename Documentation/tools/rtla/{common_options.rst =3D> common_options.tx= t} (100%) rename Documentation/tools/rtla/{common_osnoise_description.rst =3D> commo= n_osnoise_description.txt} (100%) rename Documentation/tools/rtla/{common_osnoise_options.rst =3D> common_os= noise_options.txt} (100%) rename Documentation/tools/rtla/{common_timerlat_aa.rst =3D> common_timerl= at_aa.txt} (100%) rename Documentation/tools/rtla/{common_timerlat_description.rst =3D> comm= on_timerlat_description.txt} (100%) rename Documentation/tools/rtla/{common_timerlat_options.rst =3D> common_t= imerlat_options.txt} (100%) rename Documentation/tools/rtla/{common_top_options.rst =3D> common_top_op= tions.txt} (100%) diff --git a/Documentation/tools/rtla/common_appendix.rst b/Documentation/t= ools/rtla/common_appendix.txt similarity index 100% rename from Documentation/tools/rtla/common_appendix.rst rename to Documentation/tools/rtla/common_appendix.txt diff --git a/Documentation/tools/rtla/common_hist_options.rst b/Documentati= on/tools/rtla/common_hist_options.txt similarity index 100% rename from Documentation/tools/rtla/common_hist_options.rst rename to Documentation/tools/rtla/common_hist_options.txt diff --git a/Documentation/tools/rtla/common_options.rst b/Documentation/to= ols/rtla/common_options.txt similarity index 100% rename from Documentation/tools/rtla/common_options.rst rename to Documentation/tools/rtla/common_options.txt diff --git a/Documentation/tools/rtla/common_osnoise_description.rst b/Docu= mentation/tools/rtla/common_osnoise_description.txt similarity index 100% rename from Documentation/tools/rtla/common_osnoise_description.rst rename to Documentation/tools/rtla/common_osnoise_description.txt diff --git a/Documentation/tools/rtla/common_osnoise_options.rst b/Document= ation/tools/rtla/common_osnoise_options.txt similarity index 100% rename from Documentation/tools/rtla/common_osnoise_options.rst rename to Documentation/tools/rtla/common_osnoise_options.txt diff --git a/Documentation/tools/rtla/common_timerlat_aa.rst b/Documentatio= n/tools/rtla/common_timerlat_aa.txt similarity index 100% rename from Documentation/tools/rtla/common_timerlat_aa.rst rename to Documentation/tools/rtla/common_timerlat_aa.txt diff --git a/Documentation/tools/rtla/common_timerlat_description.rst b/Doc= umentation/tools/rtla/common_timerlat_description.txt similarity index 100% rename from Documentation/tools/rtla/common_timerlat_description.rst rename to Documentation/tools/rtla/common_timerlat_description.txt diff --git a/Documentation/tools/rtla/common_timerlat_options.rst b/Documen= tation/tools/rtla/common_timerlat_options.txt similarity index 100% rename from Documentation/tools/rtla/common_timerlat_options.rst rename to Documentation/tools/rtla/common_timerlat_options.txt diff --git a/Documentation/tools/rtla/common_top_options.rst b/Documentatio= n/tools/rtla/common_top_options.txt similarity index 100% rename from Documentation/tools/rtla/common_top_options.rst rename to Documentation/tools/rtla/common_top_options.txt diff --git a/Documentation/tools/rtla/rtla-hwnoise.rst b/Documentation/tool= s/rtla/rtla-hwnoise.rst index 3a7163c02ac8e8..26512b15fe7ba5 100644 --- a/Documentation/tools/rtla/rtla-hwnoise.rst +++ b/Documentation/tools/rtla/rtla-hwnoise.rst @@ -29,11 +29,11 @@ collection of the tracer output. =20 OPTIONS =3D=3D=3D=3D=3D=3D=3D -.. include:: common_osnoise_options.rst +.. include:: common_osnoise_options.txt =20 -.. include:: common_top_options.rst +.. include:: common_top_options.txt =20 -.. include:: common_options.rst +.. include:: common_options.txt =20 EXAMPLE =3D=3D=3D=3D=3D=3D=3D @@ -106,4 +106,4 @@ AUTHOR =3D=3D=3D=3D=3D=3D Written by Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation= /tools/rtla/rtla-osnoise-hist.rst index 1fc60ef2610677..007521c865d97e 100644 --- a/Documentation/tools/rtla/rtla-osnoise-hist.rst +++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst @@ -15,7 +15,7 @@ SYNOPSIS =20 DESCRIPTION =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D -.. include:: common_osnoise_description.rst +.. include:: common_osnoise_description.txt =20 The **rtla osnoise hist** tool collects all **osnoise:sample_threshold** occurrence in a histogram, displaying the results in a user-friendly way. @@ -24,11 +24,11 @@ collection of the tracer output. =20 OPTIONS =3D=3D=3D=3D=3D=3D=3D -.. include:: common_osnoise_options.rst +.. include:: common_osnoise_options.txt =20 -.. include:: common_hist_options.rst +.. include:: common_hist_options.txt =20 -.. include:: common_options.rst +.. include:: common_options.txt =20 EXAMPLE =3D=3D=3D=3D=3D=3D=3D @@ -65,4 +65,4 @@ AUTHOR =3D=3D=3D=3D=3D=3D Written by Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt diff --git a/Documentation/tools/rtla/rtla-osnoise-top.rst b/Documentation/= tools/rtla/rtla-osnoise-top.rst index b1cbd7bcd4aed2..6ccadae3894570 100644 --- a/Documentation/tools/rtla/rtla-osnoise-top.rst +++ b/Documentation/tools/rtla/rtla-osnoise-top.rst @@ -15,7 +15,7 @@ SYNOPSIS =20 DESCRIPTION =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D -.. include:: common_osnoise_description.rst +.. include:: common_osnoise_description.txt =20 **rtla osnoise top** collects the periodic summary from the *osnoise* trac= er, including the counters of the occurrence of the interference source, @@ -26,11 +26,11 @@ collection of the tracer output. =20 OPTIONS =3D=3D=3D=3D=3D=3D=3D -.. include:: common_osnoise_options.rst +.. include:: common_osnoise_options.txt =20 -.. include:: common_top_options.rst +.. include:: common_top_options.txt =20 -.. include:: common_options.rst +.. include:: common_options.txt =20 EXAMPLE =3D=3D=3D=3D=3D=3D=3D @@ -60,4 +60,4 @@ AUTHOR =3D=3D=3D=3D=3D=3D Written by Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt diff --git a/Documentation/tools/rtla/rtla-osnoise.rst b/Documentation/tool= s/rtla/rtla-osnoise.rst index c129b206ce3484..540d2bf6c15247 100644 --- a/Documentation/tools/rtla/rtla-osnoise.rst +++ b/Documentation/tools/rtla/rtla-osnoise.rst @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -.. include:: common_osnoise_description.rst +.. include:: common_osnoise_description.txt =20 The *osnoise* tracer outputs information in two ways. It periodically prin= ts a summary of the noise of the operating system, including the counters of @@ -56,4 +56,4 @@ AUTHOR =3D=3D=3D=3D=3D=3D Written by Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt diff --git a/Documentation/tools/rtla/rtla-timerlat-hist.rst b/Documentatio= n/tools/rtla/rtla-timerlat-hist.rst index 4923a362129bbd..f56fe546411bd4 100644 --- a/Documentation/tools/rtla/rtla-timerlat-hist.rst +++ b/Documentation/tools/rtla/rtla-timerlat-hist.rst @@ -16,7 +16,7 @@ SYNOPSIS DESCRIPTION =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -.. include:: common_timerlat_description.rst +.. include:: common_timerlat_description.txt =20 The **rtla timerlat hist** displays a histogram of each tracer event occurrence. This tool uses the periodic information, and the @@ -25,13 +25,13 @@ occurrence. This tool uses the periodic information, an= d the OPTIONS =3D=3D=3D=3D=3D=3D=3D =20 -.. include:: common_timerlat_options.rst +.. include:: common_timerlat_options.txt =20 -.. include:: common_hist_options.rst +.. include:: common_hist_options.txt =20 -.. include:: common_options.rst +.. include:: common_options.txt =20 -.. include:: common_timerlat_aa.rst +.. include:: common_timerlat_aa.txt =20 EXAMPLE =3D=3D=3D=3D=3D=3D=3D @@ -110,4 +110,4 @@ AUTHOR =3D=3D=3D=3D=3D=3D Written by Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation= /tools/rtla/rtla-timerlat-top.rst index 50968cdd2095a1..7dbe625d0c4243 100644 --- a/Documentation/tools/rtla/rtla-timerlat-top.rst +++ b/Documentation/tools/rtla/rtla-timerlat-top.rst @@ -16,7 +16,7 @@ SYNOPSIS DESCRIPTION =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -.. include:: common_timerlat_description.rst +.. include:: common_timerlat_description.txt =20 The **rtla timerlat top** displays a summary of the periodic output from the *timerlat* tracer. It also provides information for each @@ -26,13 +26,13 @@ seem with the option **-T**. OPTIONS =3D=3D=3D=3D=3D=3D=3D =20 -.. include:: common_timerlat_options.rst +.. include:: common_timerlat_options.txt =20 -.. include:: common_top_options.rst +.. include:: common_top_options.txt =20 -.. include:: common_options.rst +.. include:: common_options.txt =20 -.. include:: common_timerlat_aa.rst +.. include:: common_timerlat_aa.txt =20 **--aa-only** *us* =20 @@ -133,4 +133,4 @@ AUTHOR ------ Written by Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt diff --git a/Documentation/tools/rtla/rtla-timerlat.rst b/Documentation/too= ls/rtla/rtla-timerlat.rst index 20e2d259467fd0..ce9f57e038c37f 100644 --- a/Documentation/tools/rtla/rtla-timerlat.rst +++ b/Documentation/tools/rtla/rtla-timerlat.rst @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -.. include:: common_timerlat_description.rst +.. include:: common_timerlat_description.txt =20 The **rtla timerlat top** mode displays a summary of the periodic output from the *timerlat* tracer. The **rtla timerlat hist** mode displays @@ -51,4 +51,4 @@ AUTHOR =3D=3D=3D=3D=3D=3D Written by Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt diff --git a/Documentation/tools/rtla/rtla.rst b/Documentation/tools/rtla/r= tla.rst index fc0d233efcd5df..2a5fb7004ad448 100644 --- a/Documentation/tools/rtla/rtla.rst +++ b/Documentation/tools/rtla/rtla.rst @@ -45,4 +45,4 @@ AUTHOR =3D=3D=3D=3D=3D=3D Daniel Bristot de Oliveira =20 -.. include:: common_appendix.rst +.. include:: common_appendix.txt base-commit: 3a8660878839faadb4f1a6dd72c3179c1df56787 --=20 An old man doll... just what I always wanted! - Clara