From nobody Mon Dec 1 22:04:06 2025 Received: from mail-pl1-f177.google.com (mail-pl1-f177.google.com [209.85.214.177]) (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 3034E242D6B for ; Fri, 28 Nov 2025 15:18:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.177 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1764343131; cv=none; b=Sqp9flrfcmIJZVNIfLNY+DAGsTe+REJ4AhSAKydVFmfEB6iKNHQKFq4bgRxI3PM7Ev5FvmBnowPT1qYMvSUlgnNrSYiDZjwgLrtWNLMU06u/htBop96Fr5+DBPJ4A6prgw1AeieEoDgUE4Bmi88p9oywtvJT2bbAjWYq5BKcoY8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1764343131; c=relaxed/simple; bh=77vkR0+1JCLSlChPUV7mfgMnrTVHDOFl297gadUE40c=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=bJHM8exX3BuF4PegbnZwtkbtECMDfTB4OoqpUQJlnl4MeQOGVQup/8RL306MwkJPc6O/RQMkQm/EgcJRqHwBybbRd7dga6ViK0BG5MjZwrOzMYqVyTSjyAWrBAZpIrmWtAESb6k5eAzgo29jcTW6g7FnnvYshHemdY/EkyL9Dn4= 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=Vld9HZWN; arc=none smtp.client-ip=209.85.214.177 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="Vld9HZWN" Received: by mail-pl1-f177.google.com with SMTP id d9443c01a7336-29555b384acso23201175ad.1 for ; Fri, 28 Nov 2025 07:18:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1764343128; x=1764947928; 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=qB15gwXBroqkrK/PKr7oQFDmRDy1z34ETO6NhfgHsEw=; b=Vld9HZWN/LIZDhgmPy0nKU4VeEWN8ZwtgJdDuy8HY1Vrq4GVkz0mxBMkewz0OYgg4U p7BhFhq+/a+EubimiWPsMx6osbX5V0iRJ9dHFLy+4ibOVTlH2HVd1ksLSHoY8QJsnrSn Qwoiu8j7jtUP3SmSjnVqvB20+Q1t5xW+7qRBSpEwOLRoOQhQaMDeLdHNipVKqQenqE0G yW8rWAUCu4KaO25oiCaEDxYm35+QC8SelfzRLyuJHbu+r57yBA9XnTjOHX9g5JKwSwvT 67hOEQQgVnkCBeP/Q0BHFJaFlQlBmOQ2gKhZsiXAVpsz+npuerkwuIKUN3jMbTNZw3np /zjw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1764343128; x=1764947928; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=qB15gwXBroqkrK/PKr7oQFDmRDy1z34ETO6NhfgHsEw=; b=BxtMCjm6dLtLC0yotv+ZK+0bhs+r/r6VMMbLwCc/4kdFzlayMHGmZ1OvWluJ/obUXy mdckRNcy7KVdSjfygvNzw+GFqsHe/a0EOhcjAotLKc6AI+KiAkIr7lgrVZHaq6x0ASYj Np12LeQtChqVY0CisLe5Vf+1CyuKvMCxQqFL7WNmekwA69hxsLKTKB+CEBDBi4/Zl0a/ eVMA3wTvnHoxbyZgSTj/G2pV6wSZvhT4hx+6237XzA4XufCKSM2SPMWD20C3zm/YdicZ cncxvHG4897Sknk0rFsoxGVbTL/IVkyNm+6b5VefEzVNDnBspDH5/gLo1ZCYOAwl92Ig x6bw== X-Forwarded-Encrypted: i=1; AJvYcCXMY3udz/C5q0IqY32c/MDflChvCEBgSbAwoMfMKKIrhkVYq6t4LU6fxjs+ewOVz+xQk7423LieCQeKfys=@vger.kernel.org X-Gm-Message-State: AOJu0YzTmZzCYcimyQQNyhbjGCR4sU5ET9Ixoe7lRFeUTeDTUSBKkdVk xUKpoxUxBnVhKGPMGBkCso4HvL7vBJyhLlSlSoRkyNDqn4luoZsLzP9GECtn1/ZWCg== X-Gm-Gg: ASbGncvjYMiFjFbajP6SHIW4/ykGW8HXcV27v2JqXw2LRgk2cb0Igd7PrwJB5f0SrVd yCoP/4FCagwjGk7JvRNOiaaqXsO67Mzn7Wl0zJn7+YHFQ4t2WIGXvgW1mz1JTbQyYkCxIuhBPan Szz39AeZ7wi+JinEFpxHOzzj5pSa7/JOoG5lLx+7jlmX217xXbyn1BMt7uJTMu2TJPHCmOCuyXS PixY55omeIZ6GjIhyet/ySvSmg0ZUws3AuUczDRu69jKv5QQYV4+G0vWJy8L7PiBKS7oNobdhRZ XOOrsXHxwM/ZynGhOQmHnRfNe3T1baDza6GHw61CPT0qJ6rF3swH17DlYJZPwhwv380pbBfRlOl tbErNPViG69yHQQhwj3+35CI57t8kKu22lvTti6vDhvNu6asHnsZOSy/YBAJ7Q1sF1vljp/M6vE skKHS72UxPFkLxIhODEmDXUX6vKH89Q0PgJ4K+3NPTzTY4Rg== X-Google-Smtp-Source: AGHT+IFMZPGeYzAXlC4s7H1GRQcgTEvVdLdV7GOhi3U/+54OuO5WVgJO+4Ca80HXmsdLRnU/cszaIQ== X-Received: by 2002:a17:902:ebc1:b0:26a:ac66:ef3f with SMTP id d9443c01a7336-29b6c3c2857mr249858005ad.8.1764343127369; Fri, 28 Nov 2025 07:18:47 -0800 (PST) Received: from samee-VMware-Virtual-Platform.. ([2409:40c0:1f:b21d:eb16:b830:6608:73b4]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-be4fb2490bcsm5064944a12.2.2025.11.28.07.18.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 28 Nov 2025 07:18:46 -0800 (PST) From: Sameeksha Sankpal To: rostedt@goodmis.org, corbet@lwn.net Cc: linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Sameeksha Sankpal Subject: [PATCH] Documentation: tools/rtla: remove undefined substitutions in common_options.rst Date: Fri, 28 Nov 2025 20:48:38 +0530 Message-ID: <20251128151838.7985-1-sameekshasankpal@gmail.com> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" The RTLA common options documentation uses several Sphinx substitution placeholders (|threshold|, |tool|, |thresharg|, |tracer|, |actionsperf|) that are not defined anywhere in the tree. This causes the htmldocs build to fail with multiple "Undefined substitution" errors. Replace these undefined substitutions with plain text or generic placeholders (, , ) to ensure the documentation builds cleanly while preserving the intended meaning of the examples. Signed-off-by: Sameeksha Sankpal --- Documentation/tools/rtla/common_options.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/tools/rtla/common_options.rst b/Documentation/to= ols/rtla/common_options.rst index 77ef35d3f831..bd5a6f32f5bf 100644 --- a/Documentation/tools/rtla/common_options.rst +++ b/Documentation/tools/rtla/common_options.rst @@ -56,7 +56,7 @@ **--on-threshold** *action* =20 Defines an action to be executed when tracing is stopped on a late= ncy threshold - specified by |threshold|. + specified by the threshold value. =20 Multiple --on-threshold actions may be specified, and they will be= executed in the order they are provided. If any action fails, subsequent actio= ns in the list @@ -85,17 +85,17 @@ =20 Example: =20 - $ rtla |tool| |thresharg| 20 --on-threshold trace - --on-threshold shell,command=3D"grep ipi_send |tracer|\_trace.txt" + $ rtla 20 --on-threshold trace + --on-threshold shell,command=3D"grep ipi_send \_trace.txt" --on-threshold signal,num=3D2,pid=3Dparent =20 - This will save a trace with the default filename "|tracer|\_trace.= txt", print its + This will save a trace with the default filename "\_trace.= txt", print its lines that contain the text "ipi_send" on standard output, and sen= d signal 2 (SIGINT) to the parent process. =20 Performance Considerations: =20 - |actionsperf| + Note: Executing actions during tracing may introduce additional pe= rformance overhead depending on system load, system configuration, and the = number of actions triggered. =20 **--on-end** *action* =20 @@ -110,7 +110,7 @@ =20 Example: =20 - $ rtla |tool| -d 5s --on-end trace + $ rtla -d 5s --on-end trace =20 This runs rtla with the default options, and saves trace output at= the end. =20 --=20 2.43.0