From nobody Thu Oct 2 14:22:15 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 1CA8D2DA76C for ; Tue, 16 Sep 2025 05:42:25 +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=1758001347; cv=none; b=G4/m6AG5bZq26UTLYgSlAb0HmMvIRiF7jQb6sckW76Bw0uOSJryLdjA2BdkBMQ18iHno0ULfM545Vh0eCqvhOf+HIL6+kGjrJtNv++B17SMsgtYM3eWKOS+8U3S3oQOAiZWU0Gvqbc64pPJWTqO0TIjkrrItWkUfkwfcLjFo1uM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001347; c=relaxed/simple; bh=iFycX2BAN7hX0KeER10Qq/N2vEd9PT/ZiaaR3gB9rS8=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Yt+bpsI1OIPjOSIf5+roC/jR2YIWbn7SYAPHis3GlXOQDdyGFJrPrYcxp9PJ4pS/Z6gBz1n2/BLQmMKXSBX2Y0vkDm6/KjQSCNIZSzxskQUpV/EWkJ7I01zA2JTg5/0RpEUGyMqT+USSHswYkJM8l46mMXWaF0PgelN6PCEu91k= 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=bsNFmpGu; 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="bsNFmpGu" Received: by mail-pf1-f180.google.com with SMTP id d2e1a72fcca58-76e4f2e4c40so4319388b3a.2 for ; Mon, 15 Sep 2025 22:42:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758001345; x=1758606145; 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=Dzt8jm8JhxQa9RfhdOFYy8EQflQhajk0iYv+kw4cn4Y=; b=bsNFmpGuhpveB8vqd07bVKPNvhXh0l2DosaqQLnTylV0S5jwdoTxpNkcSrzpFAUdMm 5FiY7z4YHNNGjxtB8d/PjeYoSol3yYnW7OYDEV65Karn6shyE4xtTc9m6KRycE3cy3Ly w3m1Sx+qBkHuagV2Gzy/U33cfqw4aFzesuDhEYv3Dm6wHgGLDO8UKCIBx/qLAY0J8oLs G7kEHvdVhMhQO00jN6ZeIl4rl7uAbRMoyA2Pc5QnBfKeATzegTOTqxy+vMjOrehZEzIZ NzU3GEadBbTgS2fUm/uYLdHZQiHdCa3a+FZjrK6p5Pzytgr/DijgJwHkiW52XU66KSyY OnGg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758001345; x=1758606145; 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=Dzt8jm8JhxQa9RfhdOFYy8EQflQhajk0iYv+kw4cn4Y=; b=k6cYYXoU3+jYhSGoGH66XBuOqN8dpsSg6ASf6H96IUcYCX99rIGxb3bGzNfeuvd1Gp f8nAI6mGFO3iAtixykYC05hzunrCtgd13xML2g8fJTpsA53fFx6RuZfhoCFNmZ+DXpP2 v0GgFhHaZL/ojSIaPbpGmdI4HwCApC7HOq3ztYEcYoQ8o3QExijrOrqKxxdYHkwl7sVd CaQ3TeNy9SO0bEjvu0UVmCj49J7VQWUx8/ag13VFtfX+x2Quw+ddGI2MGQYMnp89k5fe 1T6w2oqZ6GzemmKDeWKKoEqsjcCc+/gGFLERn/ZOeKxRAFigGGWoQ31MA+sVmYPhc/bh LXlw== X-Gm-Message-State: AOJu0YzNj7+wR0NVY/ovXJVOePKUFtFGgHpZEsh2KwFPhsofzruhJWpf vIxXdHANB/ZwhGyG+0rxBEgLUdNz2LqD8lJFEVmhAR4gyAOZ5TrvaejS X-Gm-Gg: ASbGncuY+JtJ/g7Wdi7AM9Vr5KazCt0BCsv2XtE24iMbUiLgEDRmyzmimI59/ufFpF9 Yghl+jKocm1Syj0QT1XY0QhWoC+qwSxfBkzjcXmLrxQsKpjtv0qMh2IHAONJRRG1w1YcBtHNBRy yT46xTEelYhB6OjiNi64x1YGuREXzbuuqqntfar7CgVOa4liyEgX24mk9VPpp+3ohViKtcCnNwj M33COBOwOtdZKZWhq1bajV/rPxe71exLrkXSzMchOraAGUXSHzjvrYIlJE4Eb0DIK6oLoNwFpgH ditPp+bQLYiQZLc442uTdkrfxN2ZUXPV0uEj7YlPKXhNjQYiqWsaiaS9bf+l0+cg2A9qtmpRPBs Vr0rs6Dws/o1K+B9o5NyxT0olPA== X-Google-Smtp-Source: AGHT+IERvIDfQ9i3bIonnATiSRpxkSuZxnxy4IiIBGBcwTK6cxHQPmYWEwl6AsIZqqsEIp8yGjYcmQ== X-Received: by 2002:a05:6a21:998e:b0:24a:b2eb:6675 with SMTP id adf61e73a8af0-2602a59332bmr18403353637.13.1758001345194; Mon, 15 Sep 2025 22:42:25 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-b54dd63d5e5sm1155741a12.4.2025.09.15.22.42.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Sep 2025 22:42:23 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 27C9C41FA3A1; Tue, 16 Sep 2025 12:42:18 +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 v2 1/5] Documentation: trace: histogram: Fix histogram trigger subsection number order Date: Tue, 16 Sep 2025 12:41:59 +0700 Message-ID: <20250916054202.582074-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250916054202.582074-2-bagasdotme@gmail.com> References: <20250916054202.582074-2-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=5050; i=bagasdotme@gmail.com; h=from:subject; bh=iFycX2BAN7hX0KeER10Qq/N2vEd9PT/ZiaaR3gB9rS8=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBknfpglNjptrzyX3jn74zxGyanyl11lQifv9qu+If2Br +pY0t/cjlIWBjEuBlkxRZZJiXxNp3cZiVxoX+sIM4eVCWQIAxenAEzEyYCRYU76nXPz/mb+fH3F ++EcZvnZeaXh+YdVnUTyOjYsXJT8pJKR4YhJQHeT/mn5no+CkT8lPTPPnbbyWJvTt679SPPj8G0 lzAA= 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. Reviewed-by: Tom Zanussi Reviewed-by: Masami Hiramatsu (Google) Signed-off-by: Bagas Sanjaya Acked-by: Steven Rostedt (Google) --- 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 14:22:15 2025 Received: from mail-pj1-f47.google.com (mail-pj1-f47.google.com [209.85.216.47]) (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 919D32DAFDD for ; Tue, 16 Sep 2025 05:42:26 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.47 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001348; cv=none; b=Cwvb1Uw9U/+GZb1sUdEwjyZhrfGrbaMt0DOi1qNtsjJKINiqSqS9/SyvOPjsJq4sgUd+tDry10rINOvOJ6GQVdpRuDuySUEHY5mXqNnHw1TAoCcEAMGzUeY+HVpzBL3UdL1xxnZXtZ3wl6H2HCD37C2OkNRbBOZZHCsYDM5MRx0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001348; c=relaxed/simple; bh=s3GvmSoy5s2bHxCYgUEWv9aakkUAInGXHQTxN3diAb4=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=jvaWpMCwm8ClVWRe/QSOMoHiFAw70pqV0vmGRff022IONmGSr9421HQNu6v8iFGA3rYhw9eOkYqJSMn7+SKtPCScugSMy7jXb+tz4cpavFhkRFMO+5Oft8/Bka8xFe0AKcrTNNG8Z3aB9P81meQhH7uRx5/e5YgAvmLjsiL3kuc= 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=P/dPGdW5; arc=none smtp.client-ip=209.85.216.47 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="P/dPGdW5" Received: by mail-pj1-f47.google.com with SMTP id 98e67ed59e1d1-32e3726e2bbso2163488a91.2 for ; Mon, 15 Sep 2025 22:42:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758001346; x=1758606146; 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=yqFW5edEm5BNR652JSYlQ4eaSBZxreKvI2dyuTcl96U=; b=P/dPGdW5xm1/Gb8Vw3npgW9y67/CdvNUHrVEOkBWIv7js0TUZUbwFvHiSZLcaL4Puq qmQlJsITumcyq4Rfa1cPNMGRtttwPVnxwbUWhipYWlzjoPlNbGa/qdaXI8JF9fTFrjTb b+0f1Q3nKhrbjl0dN/8ymU21o6/P1FniyL4EusNKj/KE1rfEJ8b2PYu0WJUPmHNgPpdx o+jW14VLvoisAPc9FEbB1JwhEZS6VEKA6pi0N3/ilt6YJpvX1matLV/ozTKBPPj+PDHD L38WVjnSiBaOdAop2iWlO7XDIyT6AeUhmiuR52wXm8bB4rYXh/jSA//ZtLp7/2gSN2/u QMjQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758001346; x=1758606146; 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=yqFW5edEm5BNR652JSYlQ4eaSBZxreKvI2dyuTcl96U=; b=wCOCGEOnL0DKgDLIevw/AmSPG3lit0ZHDQzhnrYTGHXQ+zNGnTFMyy2qRJuVEshIfR umRfoiUfkJJAG6GrzBGUkXeTQWTsLudtRBQzPoxDSli2v/RBqYoHR3KmHQ4GO3SGFSIu xWEVS3rO5Jt5vf1WUsgC+b6qrOPLYbHfSEoAJWz2BgxcYJsYgO61dUDaydsMgA8X4ArH /B/EzM7ssCGUCznT1KLmlsrUI7XX6mgN8IjnNOeaaSgOvazMuhIoC5DGY9U14sclDicK FKt3n7WcdbxSXKw5G8hhdZhLPRVtciO0P5LFGAAHw0Go6CttKmJl8NZQ1JeKe1YEBIqu wlFw== X-Gm-Message-State: AOJu0YxpdX7Zmms9R+u3uR6TDGWlqeDs66i4gzsISDdBoFozul82HGib MdbyKOZ8d5uae6bOUbdKn1h5nVMfHmYw6W+HeGKKhpWyxdKh7ynhUrzss6B8vg== X-Gm-Gg: ASbGnctIFrw+TYaaScndyFiUakf65d0zMrgLOB0vnCaRAXV+RNTM212WkFgl57fVNDC zwkQTFtq2VZzYPq4h3Ze/9/lFjVJn527RebicjojQQXMfmQacvqni+UZjDoKp0th/XKvYp5L9+g SOFF11o5NITOHif4bvDfYYKNXBUIXuFBwoG01beeP9KrqNDnk1N0GHf8AFUpLqRIMqbgBdHE/uZ CsK+SugHoJboGUKjex0Xql+Ywp88vjae5YW6Vtv0jUD2FpvhvqUU4onFXeD+r/PUYD3eJezEd/0 GmWjyn3Gy2EYPuyTGwzGCoUTqkuLR2qQN3mQAvfNffd/aANTdpQWYkxQPUrK5MDdYM4ZyleCycs pYJsxRlUni/9gRdpSOZ0oOKGL2jLEWJfTr5635GTfKo72 X-Google-Smtp-Source: AGHT+IF5SlzGBRZHF9Fg5+r/zQQ/zX3EeOfRCNVJSjf7e3asAYfXVYxsRAMsjecPeOX7V2iBLgIbtw== X-Received: by 2002:a17:90b:5827:b0:32e:f22:3633 with SMTP id 98e67ed59e1d1-32e0f223732mr14377214a91.24.1758001345761; Mon, 15 Sep 2025 22:42:25 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-32ea0f94005sm573088a91.1.2025.09.15.22.42.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Sep 2025 22:42:25 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 56A3E4227233; Tue, 16 Sep 2025 12:42:18 +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 v2 2/5] Documentation: trace: histogram-design: Trim trailing vertices in diagram explanation text Date: Tue, 16 Sep 2025 12:42:00 +0700 Message-ID: <20250916054202.582074-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250916054202.582074-2-bagasdotme@gmail.com> References: <20250916054202.582074-2-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=12121; i=bagasdotme@gmail.com; h=from:subject; bh=s3GvmSoy5s2bHxCYgUEWv9aakkUAInGXHQTxN3diAb4=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBknfpgles41fncj+v7NZ2H1E/QMcyaLPOOWdWiw0VE/x tkkfbm1o5SFQYyLQVZMkWVSIl/T6V1GIhfa1zrCzGFlAhnCwMUpABP5ZsXw3/mv0XqFpYWa8QsW finRmnHo4S/TNaUPo0rjmP17L7Myv2dk2Jy61muy8T6Zgu2nY4Wt7rzUkg96fTHHz0B2R/irRW/ +MAAA 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. Reviewed-by: Tom Zanussi Reviewed-by: Masami Hiramatsu (Google) Signed-off-by: Bagas Sanjaya Acked-by: Steven Rostedt (Google) --- 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 14:22:15 2025 Received: from mail-pg1-f182.google.com (mail-pg1-f182.google.com [209.85.215.182]) (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 E1D062D6E4A for ; Tue, 16 Sep 2025 05:42:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.182 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001345; cv=none; b=lQrSgKfZlDpsdHOAeIHpguot0HMIdDE9NGg4nk/5P+xOWynL618QFvlghc3S6rba822iXoo0Ix758tOsZangd5mHNqXjVRFB92nSZW0pxPf++MWCfTWgnrCcYVZ9wBoruy3sFxzi+EhD2+bnQyoVp3p0MVfwudhdlASygjt15kQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001345; c=relaxed/simple; bh=IM0I2qOotzNuT503Elh5AFKW881D8AA0LxYsvx+eLpo=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=Rua7n1OYnP7/+UCQQA9fitZZtTe/Z2b4vHzc7N6mcvTPihhYvEk4VgLv4JtDujJXfpcEsFQiAFtxsqfBN7SwEh4U+iVIUX6N7mx+8W4+sKCzXYzF9DUdFG/RGGUbAgnDJl5Dgfvg08MllAT+r+WX5tkKvnbHsWodaNmCoM3GJjU= 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=WsAoY9//; arc=none smtp.client-ip=209.85.215.182 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="WsAoY9//" Received: by mail-pg1-f182.google.com with SMTP id 41be03b00d2f7-b54b55c6eabso2971963a12.2 for ; Mon, 15 Sep 2025 22:42:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758001343; x=1758606143; 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=1DPf9GY80lnpMXx7381cdrBChaqI4wIuCjM7QR2i8T8=; b=WsAoY9//wbPwPNHGeS1FGPPUsNOsm01pp7uBWqFx3DIyxzZMoXWLsKZMHnpor4buPO 3HntoLR6D0XKI2PBAaYojE0kx9mQfDWEFLoi1cT4CSo8fmlw3tYVOK2LK93bngblZWQS puVBY89WVT3EBa4ZsImZAlqswCatN+B4aSpijA8MMYiQhOgzitqB6HeRFmphztkYRttq cB3LxU38wq91G7dx3InvbXV/swPCMe1+oIogRA76YObxyc30FOwhv7vMrC5ZhR4hZ0lb caH/qoHRWncV3rjhYWE2e7qkg2wji3oibap54Vi8FeJ3DzNxbRfwqyaa3aR1M3SChQqp qKhQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758001343; x=1758606143; 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=1DPf9GY80lnpMXx7381cdrBChaqI4wIuCjM7QR2i8T8=; b=m9vQkhOISJ56f7rMClWuG5H0kybrelque9PgiR+RLtfeRXpiB7HYWNQwGD/tb6SwI7 yBRGTtq35+/RnRymrDUkolKZl8S4BwAWdDaCcmHaWE7DF62FfD9uURBn1aj6F5qt5Yji hpKEM0SJdwlnLhjE4XN0JiM0NNjO6rxnnMiSchg2/ApenkE9w4xcTD9GRGk0POI3YcVT lDwJTNxFzUwFJeWiAC5IGTjNpfezdAsZMb+OCMOr7WuMZ15eaSwsmcVFPaCS1CB0xMD3 PLaYjpGnZqmPuyNjQL1jsDlWd08wuc1IFD3XXV9FPqzcDNZ+/5lpG3NoYLS8at40syOL oPLg== X-Gm-Message-State: AOJu0Yy4sSZiposWbOys24aesxKBKtL0JEaJBfJjXQRwbhq4moI6Y7K+ qtgkLXILaKp89Fq1EtImaxyOiP68LmnhPFNkZZcdi7Bht6gS+vTKKKVa X-Gm-Gg: ASbGncvjTHiOq88tUMWXckiE/Xp8HPWLSYafs18io9N5KSZxLkB96E9ZlecvnHOjBm5 jnbAJfpleY+PYIt/ZSoGOLBdz9beZmRL5Zz5OHBdOtzjaIQt4fSwUVU5DtAm34VtUDcF7COsU7K B5TZzaq+l0brkzDnEJuUsr45juHY879UV6bd6+sGLn26EC+GSAvI0+NLBCAJt7SVsE7cB44QO9M wwv5hvb7KVsCZ8k+s5uUJqcluDnKqfPxab/KFIrRAdIn+1sT6NE7LxIckh7x/6NN34KxvN40+3J WYophP4AWV8k/QKfdFCITA7U8dEzZVtO5dyrqC9TG0SvsX/D/uDr/SQbZ4NeK3J/u1L762XJexJ JiMQe2XBeGhxsuzXiI56KNd3Sgw== X-Google-Smtp-Source: AGHT+IGjod8lqjLaEANJx/f3tL+YzsyYDJl9LPFcu3JZwKlmcwWUqkWf82sUbluRqo8+bR8l8AKKKw== X-Received: by 2002:a17:902:e5d2:b0:24b:62ef:9d38 with SMTP id d9443c01a7336-25d24bb34c6mr224282945ad.19.1758001343029; Mon, 15 Sep 2025 22:42:23 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-267d4d45427sm5867495ad.147.2025.09.15.22.42.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Sep 2025 22:42:22 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 741414227235; Tue, 16 Sep 2025 12:42:19 +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 v2 3/5] Documentation: trace: historgram-design: Separate sched_waking histogram section heading and the following diagram Date: Tue, 16 Sep 2025 12:42:01 +0700 Message-ID: <20250916054202.582074-5-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250916054202.582074-2-bagasdotme@gmail.com> References: <20250916054202.582074-2-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=1159; i=bagasdotme@gmail.com; h=from:subject; bh=IM0I2qOotzNuT503Elh5AFKW881D8AA0LxYsvx+eLpo=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBknfphxGN/7ULjEouzlt4szEw/k37Flv/6dZ63ARYX5Y ot85Ho3dpSyMIhxMciKKbJMSuRrOr3LSORC+1pHmDmsTCBDGLg4BWAiUWKMDJs52NIrfC1VFE8w xNt+yFR7KRVl6JGkdfB9y2+2HQrvYhgZJi62L+duSouZsfq5xTLb6Xo7QtkrNi5drHSFcaebxdT 3LAA= 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") Reviewed-by: Tom Zanussi Reviewed-by: Masami Hiramatsu (Google) Signed-off-by: Bagas Sanjaya Acked-by: Steven Rostedt (Google) --- 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 14:22:15 2025 Received: from mail-pf1-f174.google.com (mail-pf1-f174.google.com [209.85.210.174]) (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 86B962D23A9 for ; Tue, 16 Sep 2025 05:42:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.174 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001345; cv=none; b=DdpU0Rym38YO5fDH7vwAfPg2Oe0erDozEDmBGWL2En7HeMnVkfT7pJYNCukKWYeN7aIAJWhPu8X2PNpYwu983rmCCsSZVRegyo4xnPqdSyTNPuSBmfLFgQnitX7dAzYzl+u2eeoW7nXlBjeaDjX++70qWnHncWeDNkmM19wrMFg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001345; c=relaxed/simple; bh=d2Ks+Ez2kkiMgnmwiuOB1yzGYoU50hvL0gFy9bbawNs=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=S0+qgAOP6d4X7RsJHJ1n3j5S80ZT4zMwt7ebOsdvoA8glEeI5XE9CJGw6U2+CJtVWxOXwDv4lv93mMX5e/zYhuSOI7iWRc+lTalY/kDcx9EnpnB8pGJI3dxvJez4y3O1DOBPX0e1zrPjPoIXilGbAxU1N6OX1m5N6LtdIo2ozk8= 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=fLdtZX/c; arc=none smtp.client-ip=209.85.210.174 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="fLdtZX/c" Received: by mail-pf1-f174.google.com with SMTP id d2e1a72fcca58-7724df82cabso5174558b3a.2 for ; Mon, 15 Sep 2025 22:42:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758001343; x=1758606143; 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=5OrphTQTPcPloMHaTWuSR0TqiJdZDQyGVN8eE5nU/kg=; b=fLdtZX/cIxnrc7ADRhhzQS1AQUgaMPH/yx69Cvr/3wJj7pAnYlP7BVb3vtFMmmtgD8 kG2qfDKXTf3Z9BISLpCcgHw3E6rHS87OexD93ed98M+1jd6zo47KSaz5WtnPhCYjElWc wbWgqdcbVaShig0+q/FXrcNBMyu2O3an634R0YmPHaL/Y3NWciWfO1UsqkG8PqYmyMrX 5oj0u3anQocWmwX8OlvMcDB4cy3QHmBWrO7WB3cNR4ULh0yC3Xt+PWr0PyVV5oU4gmKi vW2j3Vqp4nL19bzZZYwUkP+F7cFjhPFGS8JEqEXK9eA3ImWyHUAkTdv0fBYhI91DcNaV BGag== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758001343; x=1758606143; 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=5OrphTQTPcPloMHaTWuSR0TqiJdZDQyGVN8eE5nU/kg=; b=suZkCSVMt6upwGAj2HoCSi+jtfrfQRwU52fQcQ+CXgbbuYi5QOhsvcpO3CFF0FUP6O nP47SzpRJcEgZmjHisiF3wKjuVBRZP/3IT+1CqyWuvCeEjieXlx8H0l9gK84L2FWTXqg U6yJZ1ayYhX5htem/VRapmyyTtqpdWErN2pzzR2jA2ypx6+3ANSpsp5c/IgUeYuX1V7L Bao3F3GfcvL+Os+WI7Oti5uGGkIb7leg2mnOXY6Nbb1/8UkYHZaVv5pJ00XUPvpkvW0w jOwyJG5q8shIedN6NyJcl2F2VzNosZss0EDZP21c6SzIkM6LbU4QRHIvxjXQaLwp6nX8 6BkA== X-Gm-Message-State: AOJu0YyH+0Si0/oueFt1+rqVMZ3FIwg78X7iIe7TYiAXXMy3YgQzp52w 2L9TErtoA5rIVVApiVVfcQJw0T2ti0Og93kBXlJjLQwXAErRVblVwxz4 X-Gm-Gg: ASbGnctGyauDL/zzNe0hpriPiIZU2RbnVJHqV0Li376wcYj3sIXTJJ2rpjo9GjM/0dT PJtsBnkd4LUYYTxJB48PzAqJFwKeWuJx3y0VV8EnPJ4vgVoPQ3GeBelAI4twJdPbbbvHGQWaBZH 0LbEajevlPtQc2/NCK4ZjonvOJpXeqVmkR7LoJ78QIJUoLkBa6Pm78I1fzU0VQW8TL1uzYRGC+j bvkFGBrGczVyrspvJnZbUpCq+Vo+CuZyPDjQjerYxMQihSt4tDS9EowlbGkaAAQlBLnlTiQTmKR eNYH5+6e2QlppVS4xO+z8QiKqt0f5+EyzGTyiQ2eqFsHhAD2AQP32izp+49v0Xp3zPHCQ2yXxFb 6jeaKYeJDWvadcR+gppDIVsnEjA== X-Google-Smtp-Source: AGHT+IFjkDAeBD3m3VhlVk8jYHDU8nrvwEkAOBqjFcy5ibI78SkWM7xIqAKJtkrXYmtLfgV7adazMQ== X-Received: by 2002:a05:6a20:939e:b0:249:d3d:a506 with SMTP id adf61e73a8af0-2602ca077cbmr20640551637.57.1758001342621; Mon, 15 Sep 2025 22:42:22 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-77654a55d08sm8626719b3a.77.2025.09.15.22.42.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Sep 2025 22:42:21 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 817F84227236; Tue, 16 Sep 2025 12:42:19 +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 v2 4/5] Documentation: trace: histogram-design: Wrap introductory note in note:: directive Date: Tue, 16 Sep 2025 12:42:02 +0700 Message-ID: <20250916054202.582074-6-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250916054202.582074-2-bagasdotme@gmail.com> References: <20250916054202.582074-2-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=1552; i=bagasdotme@gmail.com; h=from:subject; bh=d2Ks+Ez2kkiMgnmwiuOB1yzGYoU50hvL0gFy9bbawNs=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBknfpirH3M5u7rrglCKnIn7+0dSGWyln3SvTbzr6rjLs ke2dA5zRykLgxgXg6yYIsukRL6m07uMRC60r3WEmcPKBDKEgYtTACYiycrwP5Yv/PU6v5fdOt+8 b4b73JbunH4qInOCllbor/XsKwNX7GVkWMJ47OTmLQ1GPuXfZziWlzSuSPl91IG/8dll7j8xDzk F2QE= 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. Reviewed-by: Tom Zanussi Reviewed-by: Masami Hiramatsu (Google) Signed-off-by: Bagas Sanjaya Acked-by: Steven Rostedt (Google) --- 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 14:22:15 2025 Received: from mail-pf1-f179.google.com (mail-pf1-f179.google.com [209.85.210.179]) (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 B52142DE70C for ; Tue, 16 Sep 2025 05:42:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001350; cv=none; b=fTmKjwT5mHhORQccnt1IGc5XmgBeGfvVSxZ1Vet6zAliuccittLFgsjYtB2RFxgqVCUXOM8AGU6uF41C2NJGj+K1+hErVpih+BoZ+HDfF8S3I3G27rnlk5iMuGAnjvlQdL0/62JhVZt6h2ELQpEdqGGZvDPe6i528HqepwE8HBk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758001350; c=relaxed/simple; bh=GCQf+fSlRoXWlrGzxejOS59aSKVCoeuvh+mZuQCTo+Y=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=RaGi4foO53RoMa1RX5AyAT2iO48dxq0EBvCUCHcTEI/IhmwzwzTJxpcKbZjCM15nqF+MKwgBJnh/fod6ir6Naopf3CFzm/WsrkpkksSW5HoySUd9GFkq5HCCAOeGT8R0ah77Lw7jusBFl3TMmtCP1wFurHEEMNPisVoZLBhRO1Y= 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=SM/fyGzH; arc=none smtp.client-ip=209.85.210.179 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="SM/fyGzH" Received: by mail-pf1-f179.google.com with SMTP id d2e1a72fcca58-77287fb79d3so3797724b3a.1 for ; Mon, 15 Sep 2025 22:42:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758001348; x=1758606148; 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=5JEHaZ9jq/KrcjOhCPcE4D4fEK4s5Ukw4ZA9TW8oNXo=; b=SM/fyGzHXgmiYo8u4kQIBGF1zOunDjnHlB0OV1kto4pyb22PEh3TdeSjIBESE6lGGu KmtDez5WmcpwM6PL44HzTq7GcvBZNShAxgKpT+/siSPbxmH+AmF+mX9B9hoeKmHL9kKQ rjCEn6OSXkvHWCZoqnq/U8gCy3inXT8GkRB02vrMPMIYnwnYpvpuhICILA66JAmjiDxV AS8nwuAIEeKnHJBJh14O4J2dusk/UJ9Osy1lf/UlQWz+ohe/xw58zdrEP4m3mvwjaiF1 O6fNHfNGGY1jLuJBGzMLAN/p7qKvLphEaSlnWYaHKzv6mzPe18QLm6/W+7w/ggC+Hy7c Vd8Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758001348; x=1758606148; 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=5JEHaZ9jq/KrcjOhCPcE4D4fEK4s5Ukw4ZA9TW8oNXo=; b=AJmNLY+xc9EokhGexYJlwNJqgaxCElau9mcJ//gi0tFcNZ7+1DBYSFrLtiURocIPwk cnYSSkZS3ZjbMyOXdbKxsoktXMxZp8xQoM1aVAwNlIKOH0CBmQEqLOdQblud7Yg7/W2o 7Qqv7i7CDg9ACi8f7yYS7wzgBTIHBT9WzQ8F6VnUChYJ7WG+R+Ns3FTg4j3D9brmO7an ZiOSIGcrJFm6V3vqjbizi7dSZSuZMpj7iynuZ4xMSKl2kajvwmbKfU66Mu/Ig76Iju38 gju5BmZ+QwvexKjt0jLhB9Ip+1Iiadf3BD7PwU4NNEeYrk50Ca/uWI0tDrUMJbw9TAN0 swrw== X-Gm-Message-State: AOJu0YzNPlRWWgfxR1UItw8/0kyqs8HrHOC3ZrYgMZssuE7No8bE/mMf Xk0wv1UAJdaOrNuKphLAONX77b7wPo+QDMopS7mmj8Z5lVZsLeZ6XsN0 X-Gm-Gg: ASbGncvrS2W4yOzk8Vewt8jBm4sZDSkoNJwB+3zh14osK9W3e4FV/y5SvYa739md387 lfkts5qCdrLVZlBndl5qmRVbAn3yDfxY/MdoBlJh442mUitA/icY7uDm/fzFlHF7sYGSOo0xqgh ITJH3BqcIYwSmhGSWgg7fgfeSW3h1ORCDi94rCovzItpGd8/jlY6U3ZVOC9eAVgyIT2dzWsJorh xvD5Z8d3cU1/uK/9l89uKwA6DyEAYh4rHQDIbyMnScvteX1AAz96lKjSI9o8fGa4c99eS7ZihGS UHVswKsuqabN6D+4alOvp4M9OIK9RK5kvzTSBIqhtXmRhebrF7jUS88BbnOn8KJqToYN0UfYMMF oJKAU6ZiFO0rT7XZ7Bkk7b7UUMQ== X-Google-Smtp-Source: AGHT+IH2awkKQxguyzU/uwVtBqGOg3ZGaTcFUil9iVYCCLUicJLX7MvepKfcuJU+DXVC/gjlgfE9Zg== X-Received: by 2002:a05:6a20:14a4:b0:262:1611:6528 with SMTP id adf61e73a8af0-2621611681cmr9714164637.29.1758001347998; Mon, 15 Sep 2025 22:42:27 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-32df315f9dfsm11822877a91.21.2025.09.15.22.42.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 15 Sep 2025 22:42:26 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 97AF54227237; Tue, 16 Sep 2025 12:42:19 +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 v2 5/5] Documentation: trace: histogram: Convert ftrace docs cross-reference Date: Tue, 16 Sep 2025 12:42:03 +0700 Message-ID: <20250916054202.582074-7-bagasdotme@gmail.com> X-Mailer: git-send-email 2.51.0 In-Reply-To: <20250916054202.582074-2-bagasdotme@gmail.com> References: <20250916054202.582074-2-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=1144; i=bagasdotme@gmail.com; h=from:subject; bh=GCQf+fSlRoXWlrGzxejOS59aSKVCoeuvh+mZuQCTo+Y=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDBknfpizHYkUTnk/IZ7D/nWJo3ycU5jjTR1Oo+W3/Tp9z j8UXlTUUcrCIMbFICumyDIpka/p9C4jkQvtax1h5rAygQxh4OIUgIsYMDI8rDyau8S8y1QvPens nXDVtwE2C3yYpl3XeLa3RdbnqPM1hv8FL6a/O23a1cgSsatpmhBnYYbvEf1Eb7f1mX+0951auIQ dAA== 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, which is written in :file: directive instead of a proper cross-reference. Convert it. Reviewed-by: Tom Zanussi Signed-off-by: Bagas Sanjaya Acked-by: Steven Rostedt (Google) --- 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