From nobody Thu Oct 2 20:46:43 2025 Received: from mail-pl1-f181.google.com (mail-pl1-f181.google.com [209.85.214.181]) (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 4C30623D7CA; Thu, 11 Sep 2025 04:25:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.181 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564739; cv=none; b=WVPbcT2DXDGJKIxLKsfPpUq9a5Z/wz87XaU56YGR6ZNNUNvHn2KbKIdZOI0kXrwsXeSCyV8LwQ9vJaa++x1d3eTAi2T7djj6y4pLBQTQJtTZS6E9zQ+DbcfyLkn9MXh6/DzZd8lhfz4IDsWZ7ceYHfbqfeZzLbyIlMTX15oMAkA= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564739; c=relaxed/simple; bh=oJxjCTe0A6srau75hm9/M017tulY0fPNDrsHPUSN/GE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=TV72gSGxR26YsqMmYzbV5gyFoBLYHE0rY1BLcRWSr/is7fldyLOs8bqDw+LHw5KR4gQvdNB9EIF4vEE+GFJTBpFEzFIJqme9rDWfjU+uT1PUMINcmHAkCiUavbYlfF1+OS0pj2I9OXe0izguv0WTVetisCqE6lf2khxLHiF7Jo4= 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=H7C/tN+P; arc=none smtp.client-ip=209.85.214.181 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="H7C/tN+P" Received: by mail-pl1-f181.google.com with SMTP id d9443c01a7336-25669596921so2299035ad.1; Wed, 10 Sep 2025 21:25:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1757564736; x=1758169536; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=GNBgN/+CL1bSLkrHrjO96e+g8m0fA/zw+kBtZE+AwY0=; b=H7C/tN+PlrzoLVkFNfE3emkh9kzZz1X0/DZjPFxuBj7EmcRl2SvrznJQmOdd/qjj0F 0knuR5pMrSlpUo3cVGUBUYcokw04CVQfHq8Blw5Clr/YvEUj2qGM87sM4t2knyklSmmm GCxtHmijQ4rYofgwfls6wc0jTPmTS73uNkgLIQ5t0zBem8AuPNlcxa983MQFf0ulQ7Db rKHsyOkPyLigNUCmWnAoTIvkoxb6/YSmG0kVOxyb7uLn75Xh+vpW9OpWEYAphtMYkVPY ByPlCUt3aWeuXW7h8LScyd6Pzsm5dUftKKXPaJbkolVCyTpmYLugdk+f0uJuQcqR7n3g pfUg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1757564736; x=1758169536; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=GNBgN/+CL1bSLkrHrjO96e+g8m0fA/zw+kBtZE+AwY0=; b=LlIESm8OtXyT+cJIKMerYLn9KTs2+eUOa3lgq06OGZZ5MgD3vZ1Jbv6mvGIiCao04A OzK7300NFs6zMi/TLjybEpGg8AW4iWTKWHpQF1DBDoTfKRUCWx4+kyjpH5YKFeX0jE57 1/29QTV73X9SFU7FRnlwnAlJV2tqVZYm2hn3XIjQ5+AaPaZAq7mG60UFuGHOIKt63tb0 tOmK7vK41+GDGDYmLvz0re0rgZ7PfX8o7SupKxpz0Jd0B2CHE/19k3cVs7UttcUHMjnC vqtAC6NWoWT1WFUxCUDZI8YPV3FvjOPK9r/Ph2BznBuG1f2F57oeOmpCKhSkRVTZHW3q GBew== X-Forwarded-Encrypted: i=1; AJvYcCWo1GP5gUe2dvt5abXvR+EIOEKxv/llSCYHBXmxhZxSHC6Q4dfy9/Q22kcOeUc4ZnPndPS/4/SmjRs=@vger.kernel.org, AJvYcCX0NrLtPgKt7nmBxu2znNnlf8Ps2VGGSKhf3whJ+Rspz66Hd0Zr/pbmQdxKZLY3VCdDAB5VaxbnGadYxMQ5Gy854fa3@vger.kernel.org X-Gm-Message-State: AOJu0Yxhh2T/MZ/j7SlhWJZq7jcwEgKchmY9kBJYaRrp16bgoh3qe3cQ f7oMcfkWGw5HFJCOWbwdGojWugPZc3wvlfiHwPxMQ0N2V79DbPNOHy0A X-Gm-Gg: ASbGncv9a+KUlPpWd2priGA1aQMOSK+YF+q8PXkQ8ETybHUebAiDYSGj5lterMJBcd1 lHnoM4hRzgP7N/+VPbcdTwV2pBIHOgnzfJoBZlPRXHrCXfX1xM0otGVsQCozi9hy9D24Z30ZnHh q+XxeXyUgE8UTLKljEWEMUuWE/wcHZjLzknTX+itNfJwACQLG3FugkzrwaGDxcC59OzweUS2tOM k1f03zoG8VOyRMUmLt+ZoMa8qBPk5BN8wfIV69jsmNNRDSYJi24dfDWqpfH7paMH1Vm09+N5DQH 5fa9ursOxVrjdsppRpVkNZ1AE07cq5ytbTy9shHzlBbdAC4dvSnl5Z6DRw/jvCY+Dk/DbRNrCes ny/svCr0GKsPJqqZ4AXHjU/XH/Q== X-Google-Smtp-Source: AGHT+IErsMpGM/2IRF+Df83fmIhsASNQKF11RaCOwSfHXLSpjWjHiR+/38PiGa3AWyD/6fBbhbBF6Q== X-Received: by 2002:a17:903:18b:b0:252:fa17:bc87 with SMTP id d9443c01a7336-252fa17bfacmr196543975ad.53.1757564736319; Wed, 10 Sep 2025 21:25:36 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-25c37294b17sm4449365ad.40.2025.09.10.21.25.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Sep 2025 21:25:34 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 744D041FA3A0; Thu, 11 Sep 2025 11:25:30 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux Kernel Tracing Cc: Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers , Jonathan Corbet , Tom Zanussi , Bagas Sanjaya Subject: [PATCH 1/5] Documentation: trace: histogram: Fix histogram trigger subsection number order Date: Thu, 11 Sep 2025 11:25:23 +0700 Message-ID: <20250911042527.22573-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250911042527.22573-1-bagasdotme@gmail.com> References: <20250911042527.22573-1-bagasdotme@gmail.com> 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=4941; i=bagasdotme@gmail.com; h=from:subject; bh=oJxjCTe0A6srau75hm9/M017tulY0fPNDrsHPUSN/GE=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBmH/M4Hn//pMn2bT2u5WbP1zyN2P7Imz5EX/ngoclXci mNer00YO0pZGMS4GGTFFFkmJfI1nd5lJHKhfa0jzBxWJpAhDFycAjCRE8KMDCf2TgyKvL0/uVq8 yLj8yF6W7TUPPqc4cc67v1LnnGqY1G+Gf1r2L7+4LPMI8PyT3SZTdin/04zOl7bpMZVLHIX3zW5 dzwIA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Section numbering in subsections of "Histogram Trigger Command" sections is inconsistent in order. In particular, "'hist' trigger examples" is erroneously numbered as 6.2, which is a leftover from b8df4a3634e08a ("tracing: Move hist trigger Documentation to histogram.txt"). Fix the order. Signed-off-by: Bagas Sanjaya Reviewed-by: Masami Hiramatsu (Google) Reviewed-by: Tom Zanussi --- Documentation/trace/histogram.rst | 34 +++++++++++++++---------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/Documentation/trace/histogram.rst b/Documentation/trace/histog= ram.rst index af6d2e15568ebd..d158dadaa42447 100644 --- a/Documentation/trace/histogram.rst +++ b/Documentation/trace/histogram.rst @@ -186,8 +186,8 @@ Documentation written by Tom Zanussi The examples below provide a more concrete illustration of the concepts and typical usage patterns discussed above. =20 -'special' event fields ------------------------- +2.1. 'special' event fields +--------------------------- =20 There are a number of 'special event fields' available for use as keys or values in a hist trigger. These look like and behave as if @@ -204,16 +204,16 @@ Documentation written by Tom Zanussi common_cpu int the cpu on which the event occurred. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D= =3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -Extended error information --------------------------- +2.2. Extended error information +------------------------------- =20 For some error conditions encountered when invoking a hist trigger command, extended error information is available via the tracing/error_log file. See Error Conditions in :file:`Documentation/trace/ftrace.rst` for details. =20 -6.2 'hist' trigger examples ---------------------------- +2.3. 'hist' trigger examples +---------------------------- =20 The first set of examples creates aggregations using the kmalloc event. The fields that can be used for the hist trigger are listed @@ -1608,8 +1608,8 @@ Extended error information Entries: 7 Dropped: 0 =20 -2.2 Inter-event hist triggers ------------------------------ +2.4. Inter-event hist triggers +------------------------------ =20 Inter-event hist triggers are hist triggers that combine values from one or more other events and create a histogram using that data. Data @@ -1685,8 +1685,8 @@ pseudo-file. =20 These features are described in more detail in the following sections. =20 -2.2.1 Histogram Variables -------------------------- +2.5. Histogram Variables +------------------------ =20 Variables are simply named locations used for saving and retrieving values between matching events. A 'matching' event is defined as an @@ -1789,8 +1789,8 @@ or assigned to a variable and referenced in a subsequ= ent expression:: =20 Variables can even hold stacktraces, which are useful with synthetic event= s. =20 -2.2.2 Synthetic Events ----------------------- +2.6. Synthetic Events +--------------------- =20 Synthetic events are user-defined events generated from hist trigger variables or fields associated with one or more other events. Their @@ -1846,7 +1846,7 @@ the command that defined it with a '!':: At this point, there isn't yet an actual 'wakeup_latency' event instantiated in the event subsystem - for this to happen, a 'hist trigger action' needs to be instantiated and bound to actual fields -and variables defined on other events (see Section 2.2.3 below on +and variables defined on other events (see Section 2.7. below on how that is done using hist trigger 'onmatch' action). Once that is done, the 'wakeup_latency' synthetic event instance is created. =20 @@ -2094,8 +2094,8 @@ histogram:: Entries: 7 Dropped: 0 =20 -2.2.3 Hist trigger 'handlers' and 'actions' -------------------------------------------- +2.7. Hist trigger 'handlers' and 'actions' +------------------------------------------ =20 A hist trigger 'action' is a function that's executed (in most cases conditionally) whenever a histogram entry is added or updated. @@ -2526,8 +2526,8 @@ The following commonly-used handler.action pairs are = available: kworker/3:2-135 [003] d..3 49.823123: sched_switch: prev_com= m=3Dkworker/3:2 prev_pid=3D135 prev_prio=3D120 prev_state=3DT =3D=3D> next_= comm=3Dswapper/3 next_pid=3D0 next_prio=3D120 -0 [004] ..s7 49.823798: tcp_probe: src=3D10.0.= 0.10:54326 dest=3D23.215.104.193:80 mark=3D0x0 length=3D32 snd_nxt=3D0xe3ae= 2ff5 snd_una=3D0xe3ae2ecd snd_cwnd=3D10 ssthresh=3D2147483647 snd_wnd=3D289= 60 srtt=3D19604 rcv_wnd=3D29312 =20 -3. User space creating a trigger --------------------------------- +2.8. User space creating a trigger +---------------------------------- =20 Writing into /sys/kernel/tracing/trace_marker writes into the ftrace ring buffer. This can also act like an event, by writing into the trigger --=20 An old man doll... just what I always wanted! - Clara From nobody Thu Oct 2 20:46:43 2025 Received: from mail-pf1-f180.google.com (mail-pf1-f180.google.com [209.85.210.180]) (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 939D523DEB6 for ; Thu, 11 Sep 2025 04:25:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.180 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564740; cv=none; b=kZfV7HFSqlJGvD+CrkhxG4dlpvJloZqT7dSvCMK8hk7wYci11n7nrXMZ44171XDA6teMH/J2/uqECJu3QFZyrgC2U/2lWqhsFEIsEh8bE3olUGqCdiTjSGw+wQ8LFJMZEYaf5BJGymH9pc+kdHjQPQh7umVEsatzUke+3QNHzx0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564740; c=relaxed/simple; bh=hl9gq1aVXuk8SRq2FntgXVgpl5nqJXpU9YAPeHsAr1k=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=k2j7IGU6Uotp6QQ4raHUw2m3M21/vixOzia7BK4HXTmJlrnLCYa2NuDGqxjYQcz4VIvFb/E/as0shMYp0ih2Q/ib6bmcO/u/rSEUOvBmllby4f0zJBjNcV4KIvIWnccgm0G64j5xdU5jlB8WarnrezHEkkHLFAIcB/I/uZZZw/o= 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=H4/xmLa6; arc=none smtp.client-ip=209.85.210.180 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="H4/xmLa6" Received: by mail-pf1-f180.google.com with SMTP id d2e1a72fcca58-7724cacc32bso240008b3a.0 for ; Wed, 10 Sep 2025 21:25:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1757564737; x=1758169537; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=n8cx1zbULZi9TOGMtPIQBsOoQknNuGF4AGIQhvpTYsw=; b=H4/xmLa6oG84ajd46FBk2UCh4fBmI4MaAkTKcZ0y1XtcbIYoFnFXtgdEmmYLZE8uDz Bmma2gpzcevItkoLzmfAL0w9V7n1TxuZHagd2hYC5eS8BdTs3ZSbU69L5NVmwy/BafAa 0G0zzZE+5p4wkNpWVV7QYfJjgxk0G+OdDRWAImIA047gHwq/SXeX8aCWxQ1uBqjZkmj5 5m1F6IYbqeDhVcsIsnR6sxYxZaClvDAJ+IExMWu0HWzoqy7/hOKBc6So+TyyD9rfT+Gr VWzWBNlEEi9H4IxVcq68mQT4qbOBVTZv8ok7xf2/zw2w/cQr5SZRe39ac4WPPZpd5aIZ q7rw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1757564737; x=1758169537; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=n8cx1zbULZi9TOGMtPIQBsOoQknNuGF4AGIQhvpTYsw=; b=pTn36hNi5qkiTqRTq5t9VFY46k9Xbxp1H5B/FUzAzymgwEIZbswbJXfqneMLHb3iiG HkpHZ8E/zCLEHIRdpLk3mr4hDZCpTXSmiYZxMRfUow4NOHYNP7/342jC+tI7j2Tctg2q 3oVWIGzJ6m5q2HfPe1DcQo/dld25e9JbcG6uvjuRTQjxgiyhXRrGjMd5NOEdusfJfAdh vfXcJft8RQYEo1z9kODL7RAJcssetjXOTyAEAQo0biWAlNlkhsyZmJrSa7NIJihrybNS yJjYD0oEIKkWKZbMNEDdZOEhtSijaHG2uzJ5uHd17uB9rS6aTqcpg1xbnYMIFFG/Ylsa d5tg== X-Gm-Message-State: AOJu0YygEzmjWvGIo5AXdygruYPPY93N4YLYrH7Bpx2ldZblnr9OTsXI j+j7T4MwWF87BReKBomIe1omyRQP/g9WhmgcSHVPnfSatDcSbYjIkxtw X-Gm-Gg: ASbGncuWW9UWoBIBybHBPMBr4u7fJJQ9eG9nosaRrL1YAzlJnLLtvoquYQjszvypHq6 g9nktFU1ZvvnEhQcORhryYT3dTEpArgIsv/GFtjJO0oIxlzB+eG9GjTl6k/9zyEUcHABEX8Ym8B 6A1xxu+YNqHO2Ux2toxyns7kWWSE3u631kFW/INMoqMX2APP2sThYuSj7TrcZ/O10Cu+bdNFu/s S/TtV6d7peVw1nxAONtKpEp3ABQNx++cpZtBM98pCsjrZfEoF0mcsWFA695nDGmfPNkPguO34vj MmSjdK64PLxNOzAsxkqRVsswMX5JsM7/JKp84QAb6l0tFZXts2zu7DGfSvQPvlqehwpV2/nou1S O+DqOjCQJt5U+NVxdKggyj8Rbgw== X-Google-Smtp-Source: AGHT+IHFeAEcp1B2iG22bZPXc/H4UpsCLlKZ1M5MBs+0Pe5NMvWliNuhRFMVGkEGFC+Kdx3M7xzPFw== X-Received: by 2002:a05:6a00:4655:b0:772:5487:c37c with SMTP id d2e1a72fcca58-7742de3fc65mr22594988b3a.22.1757564736754; Wed, 10 Sep 2025 21:25:36 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-77607a4746dsm535936b3a.29.2025.09.10.21.25.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Sep 2025 21:25:34 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 828E441FA3A1; Thu, 11 Sep 2025 11:25:30 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux Kernel Tracing Cc: Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers , Jonathan Corbet , Tom Zanussi , Bagas Sanjaya Subject: [PATCH 2/5] Documentation: trace: histogram-design: Trim trailing vertices in diagram explanation text Date: Thu, 11 Sep 2025 11:25:24 +0700 Message-ID: <20250911042527.22573-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250911042527.22573-1-bagasdotme@gmail.com> References: <20250911042527.22573-1-bagasdotme@gmail.com> 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=12012; i=bagasdotme@gmail.com; h=from:subject; bh=hl9gq1aVXuk8SRq2FntgXVgpl5nqJXpU9YAPeHsAr1k=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBmH/M7PKhJjK5ratuHySrlNd+t/Tb+wY3brhsiV7ZNiX j+6dPa3aEcpC4MYF4OsmCLLpES+ptO7jEQutK91hJnDygQyhIGLUwAmckiJkWEn54TXDLnuMwT+ HPaveyngeNfLm+H+l3+XxDobb0+fsrKPkWHrQ6PPM/heCc1xWnE/WrD9uF7J6m11bX1RUr3T3uw z/8EPAA== X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Diagram explanation text is supposed to be interleaved commentary between diagram parts that are spread out, but it outputs ugly in htmldocs due to trailing vertices as if both the explanation and the diagram are in the same literal code block. Trim trailing vertices. Signed-off-by: Bagas Sanjaya Reviewed-by: Masami Hiramatsu (Google) Reviewed-by: Tom Zanussi --- Documentation/trace/histogram-design.rst | 138 +++++++++++------------ 1 file changed, 69 insertions(+), 69 deletions(-) diff --git a/Documentation/trace/histogram-design.rst b/Documentation/trace= /histogram-design.rst index 5765eb3e9efa78..231a12bd7d461c 100644 --- a/Documentation/trace/histogram-design.rst +++ b/Documentation/trace/histogram-design.rst @@ -142,30 +142,30 @@ elements for a couple hypothetical keys and values.:: +--------------+ |= | n_keys =3D n_fields - n_vals = | | =20 -The hist_data n_vals and n_fields delineate the extent of the fields[] |= | -array and separate keys from values for the rest of the code. |= | +The hist_data n_vals and n_fields delineate the extent of the fields[] +array and separate keys from values for the rest of the code. =20 -Below is a run-time representation of the tracing_map part of the |= | -histogram, with pointers from various parts of the fields[] array |= | -to corresponding parts of the tracing_map. |= | +Below is a run-time representation of the tracing_map part of the +histogram, with pointers from various parts of the fields[] array +to corresponding parts of the tracing_map. =20 -The tracing_map consists of an array of tracing_map_entrys and a set |= | -of preallocated tracing_map_elts (abbreviated below as map_entry and |= | -map_elt). The total number of map_entrys in the hist_data.map array =3D = | | -map->max_elts (actually map->map_size but only max_elts of those are |= | -used. This is a property required by the map_insert() algorithm). |= | +The tracing_map consists of an array of tracing_map_entrys and a set +of preallocated tracing_map_elts (abbreviated below as map_entry and +map_elt). The total number of map_entrys in the hist_data.map array =3D +map->max_elts (actually map->map_size but only max_elts of those are +used. This is a property required by the map_insert() algorithm). =20 -If a map_entry is unused, meaning no key has yet hashed into it, its |= | -.key value is 0 and its .val pointer is NULL. Once a map_entry has |= | -been claimed, the .key value contains the key's hash value and the |= | -.val member points to a map_elt containing the full key and an entry |= | -for each key or value in the map_elt.fields[] array. There is an |= | -entry in the map_elt.fields[] array corresponding to each hist_field |= | -in the histogram, and this is where the continually aggregated sums |= | -corresponding to each histogram value are kept. |= | +If a map_entry is unused, meaning no key has yet hashed into it, its +.key value is 0 and its .val pointer is NULL. Once a map_entry has +been claimed, the .key value contains the key's hash value and the +.val member points to a map_elt containing the full key and an entry +for each key or value in the map_elt.fields[] array. There is an +entry in the map_elt.fields[] array corresponding to each hist_field +in the histogram, and this is where the continually aggregated sums +corresponding to each histogram value are kept. =20 -The diagram attempts to show the relationship between the |= | -hist_data.fields[] and the map_elt.fields[] with the links drawn |= | +The diagram attempts to show the relationship between the +hist_data.fields[] and the map_elt.fields[] with the links drawn between diagrams:: =20 +-----------+ | | @@ -440,31 +440,31 @@ sched_waking histogram n_keys =3D n_fields - n_vals = | | | = | | | =20 -This is very similar to the basic case. In the above diagram, we can = | | | -see a new .flags member has been added to the struct hist_field = | | | -struct, and a new entry added to hist_data.fields representing the ts0 = | | | -variable. For a normal val hist_field, .flags is just 0 (modulo = | | | -modifier flags), but if the value is defined as a variable, the .flags = | | | -contains a set FL_VAR bit. = | | | +This is very similar to the basic case. In the above diagram, we can +see a new .flags member has been added to the struct hist_field +struct, and a new entry added to hist_data.fields representing the ts0 +variable. For a normal val hist_field, .flags is just 0 (modulo +modifier flags), but if the value is defined as a variable, the .flags +contains a set FL_VAR bit. =20 -As you can see, the ts0 entry's .var.idx member contains the index = | | | -into the tracing_map_elts' .vars[] array containing variable values. = | | | -This idx is used whenever the value of the variable is set or read. = | | | -The map_elt.vars idx assigned to the given variable is assigned and = | | | -saved in .var.idx by create_tracing_map_fields() after it calls = | | | -tracing_map_add_var(). = | | | +As you can see, the ts0 entry's .var.idx member contains the index +into the tracing_map_elts' .vars[] array containing variable values. +This idx is used whenever the value of the variable is set or read. +The map_elt.vars idx assigned to the given variable is assigned and +saved in .var.idx by create_tracing_map_fields() after it calls +tracing_map_add_var(). =20 -Below is a representation of the histogram at run-time, which = | | | -populates the map, along with correspondence to the above hist_data and = | | | -hist_field data structures. = | | | +Below is a representation of the histogram at run-time, which +populates the map, along with correspondence to the above hist_data and +hist_field data structures. =20 -The diagram attempts to show the relationship between the = | | | -hist_data.fields[] and the map_elt.fields[] and map_elt.vars[] with = | | | -the links drawn between diagrams. For each of the map_elts, you can = | | | -see that the .fields[] members point to the .sum or .offset of a key = | | | -or val and the .vars[] members point to the value of a variable. The = | | | -arrows between the two diagrams show the linkages between those = | | | -tracing_map members and the field definitions in the corresponding = | | | +The diagram attempts to show the relationship between the +hist_data.fields[] and the map_elt.fields[] and map_elt.vars[] with +the links drawn between diagrams. For each of the map_elts, you can +see that the .fields[] members point to the .sum or .offset of a key +or val and the .vars[] members point to the value of a variable. The +arrows between the two diagrams show the linkages between those +tracing_map members and the field definitions in the corresponding hist_data fields[] members.:: =20 +-----------+ | | | @@ -565,40 +565,40 @@ hist_data fields[] members.:: | | = | | +---------------+ = | | =20 -For each used map entry, there's a map_elt pointing to an array of = | | -.vars containing the current value of the variables associated with = | | -that histogram entry. So in the above, the timestamp associated with = | | -pid 999 is 113345679876, and the timestamp variable in the same = | | -.var.idx for pid 4444 is 213499240729. = | | +For each used map entry, there's a map_elt pointing to an array of +.vars containing the current value of the variables associated with +that histogram entry. So in the above, the timestamp associated with +pid 999 is 113345679876, and the timestamp variable in the same +.var.idx for pid 4444 is 213499240729. =20 -sched_switch histogram = | | ----------------------- = | | +sched_switch histogram +---------------------- =20 -The sched_switch histogram paired with the above sched_waking = | | -histogram is shown below. The most important aspect of the = | | -sched_switch histogram is that it references a variable on the = | | -sched_waking histogram above. = | | +The sched_switch histogram paired with the above sched_waking +histogram is shown below. The most important aspect of the +sched_switch histogram is that it references a variable on the +sched_waking histogram above. =20 -The histogram diagram is very similar to the others so far displayed, = | | -but it adds variable references. You can see the normal hitcount and = | | -key fields along with a new wakeup_lat variable implemented in the = | | -same way as the sched_waking ts0 variable, but in addition there's an = | | -entry with the new FL_VAR_REF (short for HIST_FIELD_FL_VAR_REF) flag. = | | +The histogram diagram is very similar to the others so far displayed, +but it adds variable references. You can see the normal hitcount and +key fields along with a new wakeup_lat variable implemented in the +same way as the sched_waking ts0 variable, but in addition there's an +entry with the new FL_VAR_REF (short for HIST_FIELD_FL_VAR_REF) flag. =20 -Associated with the new var ref field are a couple of new hist_field = | | -members, var.hist_data and var_ref_idx. For a variable reference, the = | | -var.hist_data goes with the var.idx, which together uniquely identify = | | -a particular variable on a particular histogram. The var_ref_idx is = | | -just the index into the var_ref_vals[] array that caches the values of = | | -each variable whenever a hist trigger is updated. Those resulting = | | -values are then finally accessed by other code such as trace action = | | -code that uses the var_ref_idx values to assign param values. = | | +Associated with the new var ref field are a couple of new hist_field +members, var.hist_data and var_ref_idx. For a variable reference, the +var.hist_data goes with the var.idx, which together uniquely identify +a particular variable on a particular histogram. The var_ref_idx is +just the index into the var_ref_vals[] array that caches the values of +each variable whenever a hist trigger is updated. Those resulting +values are then finally accessed by other code such as trace action +code that uses the var_ref_idx values to assign param values. =20 -The diagram below describes the situation for the sched_switch = | | +The diagram below describes the situation for the sched_switch histogram referred to before:: =20 - # echo 'hist:keys=3Dnext_pid:wakeup_lat=3Dcommon_timestamp.usecs-$ts0' >= > | | - events/sched/sched_switch/trigger = | | + # echo 'hist:keys=3Dnext_pid:wakeup_lat=3Dcommon_timestamp.usecs-$ts0' >> + events/sched/sched_switch/trigger = | | +------------------+ = | | | hist_data | = | | --=20 An old man doll... just what I always wanted! - Clara From nobody Thu Oct 2 20:46:43 2025 Received: from mail-pg1-f173.google.com (mail-pg1-f173.google.com [209.85.215.173]) (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 2AEAC22154B; Thu, 11 Sep 2025 04:25:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.173 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564736; cv=none; b=dlZvUne/8ozGIFJ1yk3JoyJW25+e0z7pt18Zy1OI79atmeoxnxjxpQ7fewpEVma4kVbgzv9IHBIoJWy2568ys+ATcVv8CPO9D5rze9+lbylamFO2A1l1txi1ImaA5JHT0EChtksr4/ffQ6g9VNx812HUNZGYxH6cc7W7v8Hpk+s= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564736; c=relaxed/simple; bh=i+Pbd3ed1l2DaP8gstdwW8Ty90I7SiYDYltxbpd4oLQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=tbdO4h5n2MVJT0va+wcgN3ngwr5fx0VO8JIT67MsYnugZM9AFWqH9BOY8xqmzg8evsyGdBnkH3/LXMeGOXIxq7VxyWPtprAzNOZHOvbLdlGZdNHYnGr8F+07N1uguQULF6B+dVyc+lLt4skyfnXoh7QL5uj/u6IoELP3E7zCX2M= 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=Y8hqpOtY; arc=none smtp.client-ip=209.85.215.173 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="Y8hqpOtY" Received: by mail-pg1-f173.google.com with SMTP id 41be03b00d2f7-b49b56a3f27so195733a12.1; Wed, 10 Sep 2025 21:25:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1757564734; x=1758169534; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=CEU07XkMyVIJTgqm7gIknyaHnwvqbGQwdy6fIsQ8kMo=; b=Y8hqpOtYJwPg6dw4uE43qye50XlCwN/cFyODFB0dAdkgcY4phP7ruSWqNbLRu8h5v/ mLltf9UWZ+70nioVaHIuRiVEcFfwcG/4Ii6GRlcl9M6dR3FUx1AuSaRgJubSLNembyKd bD6l6yhbMPCUP4Ph7pWcG20ZrawXINzbc5llxAuuxNW7aHOpe0iLo4pY1wz9r5vjv5HX xYFjxyGZ+KIBUmR0GAl2Mc0MWwSC7Re0Vto4g19Wuz4WgG/RYKotmHyWhb3aeAWnZQ59 LrxUPuePOwoXCy8nlry0+YRyxqw4it4OQOpg4JzH05Y/MPJzKAKL/KyUyG6DThtCWToN f4zQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1757564734; x=1758169534; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=CEU07XkMyVIJTgqm7gIknyaHnwvqbGQwdy6fIsQ8kMo=; b=A5UNIj9yPlK7WQtiIjlmwXtAKPkw0oBuMKbYsL+uJRm4uKVDfp3DC/T3sXPkuH2BDg LO9sL/g79UUDWB8UZdaSyTiRmaKDVWboOQxEUO6x/Gcomdq71zqmt9agCOYsOFL98/et mH7f4mjfOYaHOX3fQy2IDrCbirb1u98csmuqovzfUkYdVKRv8cy2ec8xftLaE976VOBS e7slpRvHZNf0yGq8MU1f4wMks16HrFvhygLhy9ZGCvExnraH++kB3wYHKIfyrLkAQej6 eVtSrnrSzGew4P6KAUm3ODVwbkmAr0STMcM8g7pCGnHk3ZXpASMwvHn2V6PMm2LwQU78 8xTw== X-Forwarded-Encrypted: i=1; AJvYcCU43knw1jh5GH5XNWlfvIX7nKxzBrAGF3FEydJBTEiRrYDP5Oy+w/3cfafT5B20T+X7D3qpb44iFuo=@vger.kernel.org, AJvYcCXyK5YFkHbP7fj6+gVvfIijCDzIJmBLDUqRoKCmC0U1UAVVoBCGTEDHbaRbO6Dce1xvHOhFx98GC26+qIGXbdcBL1Rq@vger.kernel.org X-Gm-Message-State: AOJu0Yx9ncSd0mi7aS7IAsnbgbnF1revUsUdqYqulIQ5TEubHQ5O73xB cEe2oFyfHFTDmF7tnj0NZCCK3VECeX7qtn0kBJQ0+CoLEr1jtjuoKn9a X-Gm-Gg: ASbGncvaErr2RN9MC2pw3HicDY6chxS/2sn5J/rqNJJTi1JDcz1AkA+JtkVqqr1iwdI NSDqeHQBwRzugPqfVPsi5ojYariTeEWrwrHX9LlJFhnZA64Wa8xqrdfrbuVd1jyUAHUFI7gnvsq 0ikwPu3F2DEc/+qhAzHowYa4d/kSX4k9yJ17DPupg5RABj3loEP7n20WQ/WVRuJavUq0E/EVF0m 2veDL6DogegT9rrIvC47M/LFQobwLxUS6bkt2gfePx9yxR8fU2XIcOxFGRo8Wb/9Xl80DofiwnZ bxgBoHtPJ3hyqZdZRFwICcdLr6wNZ/eU5+eOPP5EsrPlbw+8Vv6olv1CLESGZnBdoclp4cTfgr/ Te/jiypBOq7t90XxKNyNPuz9ZX/lgwijxrfHo X-Google-Smtp-Source: AGHT+IHMPhDfUxV59Ud3FN4JAx/KKpRACSBgUVLhJ6Ucu/BDq+VrUSCOcGJ1T0eBVj3XxMrGYQ2xrg== X-Received: by 2002:a17:902:e850:b0:24c:784c:4a90 with SMTP id d9443c01a7336-2516ce603famr247383155ad.1.1757564734298; Wed, 10 Sep 2025 21:25:34 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-25c3ae29ae2sm4045395ad.120.2025.09.10.21.25.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Sep 2025 21:25:32 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id B0A2B41FA3A5; Thu, 11 Sep 2025 11:25:30 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux Kernel Tracing Cc: Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers , Jonathan Corbet , Tom Zanussi , Bagas Sanjaya Subject: [PATCH 3/5] Documentation: trace: historgram-design: Separate sched_waking histogram section heading and the following diagram Date: Thu, 11 Sep 2025 11:25:25 +0700 Message-ID: <20250911042527.22573-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250911042527.22573-1-bagasdotme@gmail.com> References: <20250911042527.22573-1-bagasdotme@gmail.com> 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=1050; i=bagasdotme@gmail.com; h=from:subject; bh=i+Pbd3ed1l2DaP8gstdwW8Ty90I7SiYDYltxbpd4oLQ=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBmH/C4ovNKc8Cn78jMZ98Z1Yf/rvV4Eqmf+km/u+579r C73OH9JRykLgxgXg6yYIsukRL6m07uMRC60r3WEmcPKBDKEgYtTACbC58Dwv3Zh5fuzwupzm7uk bjZNX84RYz8r/8LjC5wBmz8KL9B7r8zIcG/mTtcYc1mrN32sUm++uiSkrfBfJKzrx7rwGaf9nk/ nGQA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Section heading for sched_waking histogram is shown as normal paragraph instead due to codeblock marker for the following diagram being in the same line as the section underline. Separate them. Fixes: daceabf1b494 ("tracing/doc: Fix ascii-art in histogram-design.rst") Signed-off-by: Bagas Sanjaya Reviewed-by: Masami Hiramatsu (Google) Reviewed-by: Tom Zanussi --- Documentation/trace/histogram-design.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/trace/histogram-design.rst b/Documentation/trace= /histogram-design.rst index 231a12bd7d461c..4faff1669b77bd 100644 --- a/Documentation/trace/histogram-design.rst +++ b/Documentation/trace/histogram-design.rst @@ -380,7 +380,9 @@ entry, ts0, corresponding to the ts0 variable in the sc= hed_waking trigger above. =20 sched_waking histogram -----------------------:: +---------------------- + +.. code-block:: =20 +------------------+ | hist_data |<---------------------------------------------------= ----+ --=20 An old man doll... just what I always wanted! - Clara From nobody Thu Oct 2 20:46:43 2025 Received: from mail-pl1-f171.google.com (mail-pl1-f171.google.com [209.85.214.171]) (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 7B17633F9; Thu, 11 Sep 2025 04:25:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.171 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564735; cv=none; b=Pi+6MZ4A4f8BOf54HIc/LwpuSXZ3ZdUjMklnczBLRiq0Lv+s5LYfJWXwF55sOepuz03FoKsgpR0pFMR85jnrXZcXbdSjSztALpcOqUV4Gc4xBrBfbJcfjUjhMLVAu7hQti+DF+N/JEyATVyWfrDbGO3T1gJepmWa5zp72t7O4iI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564735; c=relaxed/simple; bh=PCapEjPmI5m+nD84bxhh8bD0msN75z0bb/HI8QQDCj0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=otKqr7dKceXLwLNdJ90Gkf7es8X0zHyQv4Fni+gRQpHbDqg5oZUiEXZUHtFYRONtmq7fk1vhWQydRQolrm00BpIbMZQN+RQm0/Qmh1vQmlcBI+JxyUUPHlklxDbP7wpJaUcdkxNkqTI5S468UgTlenoO3gcQzMQj9rf3O14FDvw= 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=W/zRrM5o; arc=none smtp.client-ip=209.85.214.171 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="W/zRrM5o" Received: by mail-pl1-f171.google.com with SMTP id d9443c01a7336-24cdd95c422so1597835ad.0; Wed, 10 Sep 2025 21:25:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1757564734; x=1758169534; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=sn0fDpbrxJOdsZ8BiLim0jUfus1eeCGt+uywtEWxVhg=; b=W/zRrM5oUD0KGlSW/ig9oZPhsuHZ0fFEsC54x/dlpEm6nlHnbddv62XDJiGHn22oeb hxEUpwlqD+g9pMIJ+3J74G1SXuIDSpaLr2h6aG25gP5H+xCcDTDttjr9Jbf1e+htNgxD 6jAmCEQqGu0ZrNeyuwGtYmBQzNOU7gTDMINDlIIcSQ+UfoWDARCyXu37WC1sLPq3SXDy lB0thlxBKt0niZMN+ndexahi2SuFA1ZUQ+4swCQktG+IP+anLBmvgfP04G286WM0xPF9 zC6JHGqs9Lj6vO1xfynJMi1tUEphevwpUNwDGhoo/8Fr5EUjWyzl1G4lqlym+A1Hi3uW r/vg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1757564734; x=1758169534; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=sn0fDpbrxJOdsZ8BiLim0jUfus1eeCGt+uywtEWxVhg=; b=Ck/4rASc13bUlPMnbbXwA/qxHgcnsduFxFjjogWWu6bRM0TMSLA19xevgWi99zTg8w +nt7oT44pAynVocZaSt1RLtgP7bdk+3kv50dd6khr0CKjjEIpt0vkhcA+xxE+7j4TTml HPaHPgkPp32mPRG82881/4+3xIJIlVYnUXke0DmS62SBN4wjU6eH/O6hao+xJQxAeex1 aytfle7ACJlPhFQxD79avpk7O5jELj1QBMXMjbT5t0R0or+YNvldcD2XcT8xnb8vo9yn 68lp7qaaYx3TIWUAGZTyKWhmh/tP7y8jGw805PeeglV8STzpe5hhQ7mtBaiss28uWuOJ uHbA== X-Forwarded-Encrypted: i=1; AJvYcCXtCKHIxqKoS0wlMIEQTN7XVp70xXZ3mztkMNM//aTO1X11JU74aFuee5QfqiyE6XDBJNnYpKS/lJc=@vger.kernel.org, AJvYcCXxXepJYwfvJWFDzvtakmtEzl8R0A8CswByhAeT0R9websDHkmuZkr9TGjP9zfKqhuQ2fKkXwQpS2fzmvrs67L5ge1q@vger.kernel.org X-Gm-Message-State: AOJu0Yzwbmtd2Jno6XVArEm0Bsf+LZ49u17+VouxPna1AgYLJAdKXs/z U5ocSCAhg/7QQPk3QUXIPJ3rkzdzQsb0C+rxJJXQ56NaSVxa0Rdfgox+ X-Gm-Gg: ASbGnctHgXg43P2o6XQ0E3NJdpdTNxvHIkKZug0VlsePbxNGRqsjXUYdHDuJZ8LQ1IU MfObVoF4+VCmZWv70n+9M0lSWuHGDdUTpnm53u5uQuFAjJBC6GrYHz5hUGwWj8Lg05kBF2mXVgU jWp/9LbOK0jfl8IFYURAbDs8mHqt3wPKjcrNaYPWV/ZMEYFi+iTIOoes6D+UQwLhpxZ63xyGpIc hOkhLZ6g/Q4YaMz6URrqTd35N1zdC6OE/UB/8o4ByEaYWaLvsqXBihmC7IuOeYS9ODe/CQ3hS6R sZcGgbZwNSM0g1zA/ZU8K6RPeVWcW7N7uAcw9FoGxmK5LhHf5JyOLh4Twga8aIwrGRZQROAl4j7 7YHU4ol8p8tbMBZj2S2hiRdTE3pT+9TBnwMl1 X-Google-Smtp-Source: AGHT+IGwA7u7kHvYy08QWn2RBRYK8+HxOZDkMhU7OlqshMYpfA+qxBXfNqX636KO5Oe1y7G8nlywYA== X-Received: by 2002:a17:903:3c63:b0:248:a26f:e25 with SMTP id d9443c01a7336-25174374ae2mr239240435ad.52.1757564733532; Wed, 10 Sep 2025 21:25:33 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-25c3a84a80asm4215895ad.90.2025.09.10.21.25.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Sep 2025 21:25:32 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id C0D3641F3D85; Thu, 11 Sep 2025 11:25:30 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux Kernel Tracing Cc: Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers , Jonathan Corbet , Tom Zanussi , Bagas Sanjaya Subject: [PATCH 4/5] Documentation: trace: histogram-design: Wrap introductory note in note:: directive Date: Thu, 11 Sep 2025 11:25:26 +0700 Message-ID: <20250911042527.22573-5-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250911042527.22573-1-bagasdotme@gmail.com> References: <20250911042527.22573-1-bagasdotme@gmail.com> 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=1443; i=bagasdotme@gmail.com; h=from:subject; bh=PCapEjPmI5m+nD84bxhh8bD0msN75z0bb/HI8QQDCj0=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBmH/C6U957+ZXJqVYJYRkpbnJn4rsl+s4QnTF+zt8H0j YjuM7XujlIWBjEuBlkxRZZJiXxNp3cZiVxoX+sIM4eVCWQIAxenAEzk1TRGhjtvfDe+0T2tLy1e ZLs4fu2Ml02P9D/t3fXAx+/s5pgdoSqMDHeXm3/faywbtPTeMSfRJXOLi3w6DqozKSY838sUu97 7MC8A X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Use Sphinx note:: directive for the introductory note at the beginning of docs, instead of aligned-text paragraph that renders as definition list. Signed-off-by: Bagas Sanjaya Reviewed-by: Masami Hiramatsu (Google) Reviewed-by: Tom Zanussi --- Documentation/trace/histogram-design.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Documentation/trace/histogram-design.rst b/Documentation/trace= /histogram-design.rst index 4faff1669b77bd..ae71b5bf97c6c7 100644 --- a/Documentation/trace/histogram-design.rst +++ b/Documentation/trace/histogram-design.rst @@ -11,13 +11,14 @@ histograms work and how the individual pieces map to th= e data structures used to implement them in trace_events_hist.c and tracing_map.c. =20 -Note: All the ftrace histogram command examples assume the working - directory is the ftrace /tracing directory. For example:: +.. note:: + All the ftrace histogram command examples assume the working + directory is the ftrace /tracing directory. For example:: =20 # cd /sys/kernel/tracing =20 -Also, the histogram output displayed for those commands will be -generally be truncated - only enough to make the point is displayed. + Also, the histogram output displayed for those commands will be + generally be truncated - only enough to make the point is displayed. =20 'hist_debug' trace event files =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D --=20 An old man doll... just what I always wanted! - Clara From nobody Thu Oct 2 20:46:43 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 3F86924A04A; Thu, 11 Sep 2025 04:25:38 +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=1757564740; cv=none; b=htaXQhTnKS69JJKrkN2GIhSQ9IjxUEF/ta00adSXjgk98MiRtNXdlsHBV3cfejw2/k9Da50YGm24n4tHt42UwFIyc2BYqXLADrRnVobVaoI8FyYtsuGlzwRGtoOEoapZOF83InMNVCcbRHH7mVOwUkHisOd4Zl80FmqW3WViDYE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1757564740; c=relaxed/simple; bh=jZWB1p//ISIVh97qcAyBtmJJXK3oz2kT8G7DjODCOR8=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=byyydchr3hbiIEtBe4ineq3Bn+NBC92kVff5h/bMne6RhW4lJ8iLMydzt9ai0VmBzrENHN21dxyFDQ0rOHZE85mT2jv3YKcT2NitDFRcdTAQEA8q2z48uCfq/YeSk7gEUD5ew486akq72WiUInCmDyXcpF6Rr3XcV82DiQuRiFw= 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=Y8GjP8FT; 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="Y8GjP8FT" Received: by mail-pl1-f176.google.com with SMTP id d9443c01a7336-25221fa3c9bso11370565ad.0; Wed, 10 Sep 2025 21:25:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1757564738; x=1758169538; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=lU89Xc9Cv0xX/7xLo9LGEng1r4NnOlTOyfnu4zvH4C0=; b=Y8GjP8FTgSjDRIc3nn5byfb3hojdO5klb0b3uhASwIl0/yE+v7/EHNd2wvosDC1UzZ hO+nbCqNJLDeS0AUmOzlehlPH6dLDxzbIzf8RJLNO6J1oMmfX1MudQuwpPEOGTbmAAvw 2QTRftfNwfWGC8bqQgB2B0gc1lzUREilkEXxBLPoorUZC1HdNllMcFcrjUokX/oodg9+ 9QE7/dSOtVaShqVS5Li+UfZSB/ftKct3mEygOxXh/TrneuuiKOO1az2nuFwu+Oi913EQ BHFt+AWQsmKEXHs8EUqxAVojLs33bTb+G1gSg4gOb72LuqmDjvq+x1bsqF/jnhxEXOZq gVGg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1757564738; x=1758169538; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=lU89Xc9Cv0xX/7xLo9LGEng1r4NnOlTOyfnu4zvH4C0=; b=jwROwEF0FQXW/WKP7RhJqKONxyIiu0NrYVOYE0WBDB4sG5GmTkV6jEzqtxKG4t+V0+ npVpWu9SUkRjtnddMJxJGP/h4oTVRfiXv0CUGJCKXzYU18h8zN2vVOCG0YHdkmTr1aP6 9ZV3NU0jS5tGyqWCbZy9G3340VddU3r1KkrfQ2R7nhxRyGxaYigxmScKiy0zHjfrybtG FgO/gZifsJd+rwxFizxEBfcAG0S7vO5bd5JVJw1j/gdnaWRFJm0r1YjLxUfBhWRFEv91 m06RE1kvIIuHZHGn2j4RpEXs+tprjpo0YyzkfX6OjTpkl5Q3NbxHx75NVS2TgqZcqgrT ypaw== X-Forwarded-Encrypted: i=1; AJvYcCUFLvsE3FxlTutQf20+BnaqRxH8XE++2PyTgyFeg/R33XxPFpIP93orZMWSg0q2g42tHNPPzj8n0bo=@vger.kernel.org, AJvYcCW93YgXJm4lJWP/N0d6yL2opMHrGfMb0j23sceV9P1e9lvdC+/g2eBzudpRH2fXhzvnDk+JJvOHQS5KpEVCiy0MtQT4@vger.kernel.org X-Gm-Message-State: AOJu0YzsTU7irtCaWCOMdQYOqoiO+Ff11XrWKI+Ml4y4/u1IKZwiY1bS RmuhwNMAaUI9IDnnkjtP16/AjxxR2PqrPEwzMPE4LDMXscv9/H2SlY+O X-Gm-Gg: ASbGncuCVM5OWns8rEb6wyhHsGSIY9NGtBFIcQOTTlLRluwlAzTBccU2z1gp1p9GKGY vd/e6A0MLMkhbC0ebVXG6IJjzeBzeNZ6zGOanIYbaGVajDzfmStMLBWz1GaCnILnA677X/vMnq6 BcyRLzfFMgeoOYQE2cXJl3IRv5RVn7WhJmzRY9hmbLOI81aLndT8HVq92IuzDdSrKxafw4y+Rfz G4HQEjKDOC9NMI4zCIOW6UuxNp4LutdqaclImbn5j9gzZWIvWfC6wkb4wwrbTs2yT2CyNrMViKb 010/bxEWz+2x27dBghOLA5SFqilnHyqKAfFNqc/B3ELjKBbKoqcp+tjU6RMLZ2aJJomjqMTqS6c 3NZ6xJQnS2abFsOxXnDN6dTRjmw== X-Google-Smtp-Source: AGHT+IHbS9cB5BACUix80S5lFEGDN0c9HkDKYow+/+wRkyV1CA17KHmwOoLnPeMBuOiW9pBwUbDVfw== X-Received: by 2002:a17:903:2442:b0:231:d0da:5e1f with SMTP id d9443c01a7336-25bad5670b1mr20564335ad.21.1757564738271; Wed, 10 Sep 2025 21:25:38 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-25c3a84a62esm4148865ad.66.2025.09.10.21.25.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Sep 2025 21:25:36 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id D4B8141BEA9C; Thu, 11 Sep 2025 11:25:30 +0700 (WIB) From: Bagas Sanjaya To: Linux Kernel Mailing List , Linux Documentation , Linux Kernel Tracing Cc: Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers , Jonathan Corbet , Tom Zanussi , Bagas Sanjaya Subject: [PATCH 5/5] Documentation: trace: histogram: Link to ftrace docs Date: Thu, 11 Sep 2025 11:25:27 +0700 Message-ID: <20250911042527.22573-6-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250911042527.22573-1-bagasdotme@gmail.com> References: <20250911042527.22573-1-bagasdotme@gmail.com> 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=1030; i=bagasdotme@gmail.com; h=from:subject; bh=jZWB1p//ISIVh97qcAyBtmJJXK3oz2kT8G7DjODCOR8=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBmH/C7wBhZHffl0yaDud05e5vp007M3c7Jd50XXHA+cM i+Hof9BRykLgxgXg6yYIsukRL6m07uMRC60r3WEmcPKBDKEgYtTACZy9xgjw+snTy3TOQ6+N2d+ eMW7LNTVITpmcWh2jVRNMM+9qZscdBkZ1rZc1M/2c7mxMjj1qq5rknjL02xxlSP3ZwfMObl07tx yRgA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" In brief "Extended error information" section, details on error condition is referred to ftrace docs. Add the link to it. Signed-off-by: Bagas Sanjaya Reviewed-by: Tom Zanussi --- Documentation/trace/histogram.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/trace/histogram.rst b/Documentation/trace/histog= ram.rst index d158dadaa42447..340bcb5099e7a4 100644 --- a/Documentation/trace/histogram.rst +++ b/Documentation/trace/histogram.rst @@ -209,8 +209,8 @@ Documentation written by Tom Zanussi =20 For some error conditions encountered when invoking a hist trigger command, extended error information is available via the - tracing/error_log file. See Error Conditions in - :file:`Documentation/trace/ftrace.rst` for details. + tracing/error_log file. See "Error conditions" section in + Documentation/trace/ftrace.rst for details. =20 2.3. 'hist' trigger examples ---------------------------- --=20 An old man doll... just what I always wanted! - Clara