From patchwork Tue May 3 10:26:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Schindelin X-Patchwork-Id: 12835548 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 316F3C433FE for ; Tue, 3 May 2022 10:27:02 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233981AbiECKaa (ORCPT ); Tue, 3 May 2022 06:30:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45466 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232159AbiECKa3 (ORCPT ); Tue, 3 May 2022 06:30:29 -0400 Received: from mail-wm1-x332.google.com (mail-wm1-x332.google.com [IPv6:2a00:1450:4864:20::332]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9A0D7E75 for ; Tue, 3 May 2022 03:26:53 -0700 (PDT) Received: by mail-wm1-x332.google.com with SMTP id c190-20020a1c35c7000000b0038e37907b5bso1083908wma.0 for ; Tue, 03 May 2022 03:26:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=lrGZ6FQtWBe8UARFSRcO3xMWRg1SdzwTvZSU3zZIWsQ=; b=l2QoKqnwFpH/I9/lFoduJ0Rm9uZ/+xTOXKSyyg0w9kjx4Hb0yP5SyiVU8FEGWGd4nU 0Xggf0xtjSibzAyy+dpsH53IetP2fFYCl/LVAha+Pd3bUaX5p0DxrDuFal+iV3MM/wxW muewgXvSm139khxVsGCFuFy+IoP/tmlaoPduimtsWm4gyxLHM3ROUTrcDTwzDPjocm8b fZQMgVMUt93RoAW1Y1mIgwyyxCTlP7qlaJKTkfrVAD10Fy4h++QWn4wzjHMbMSBXdply oGli2b5jPPBuE1nY3KFcncLZ3DPq63EDz5HCSuUAhKR9dsE3GjrVonypP/EhMXOtG56y /Guw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=lrGZ6FQtWBe8UARFSRcO3xMWRg1SdzwTvZSU3zZIWsQ=; b=XmWLiF07uZmKoH+XjiUcrYSUhyn1hVpKchGikyQQCRih492DyiyE1aLAqBwVhuSB0X ZWsQuyauxQBKZKhLmiqC55ncoeu6DOwEmhKGZmZHHL9GLFCjth8w4Yi4+B/RnqeJs8PZ KAVZL3OGknlGmYyN37l3JVD0Oq6vBaiMxoOq6bpO8Sg6d4Il7RF9b4EZ/OmmdRr0yPQX 2eBRSkOQkjleRBhEWGn3kN8t4bbQcAg1FngqHVB7k/P4q8iA0VcyLnneCQQRdjfHui+7 +bFP++92NdLTTvGUjxX5fv1sp3Cz1uMOenvFTyu/8iZNhCQrwE6OC1kBX7sVHgC7Gmti 10ew== X-Gm-Message-State: AOAM5302HStgw7VqJLFZJZ/xpVo9t2GAS7YTQ3A7/6ZHVGiryEc4Th7v wBylwcrfNkqTZpzFuKIMGmrKHIE33cc= X-Google-Smtp-Source: ABdhPJwKHtMeeZ6sE3nmaIkTdHeNpS4UE/nhdsvglLaov4MBV9J4JqrIiMzbzS1aaHjjY+pJ7vD2PA== X-Received: by 2002:a05:600c:3b85:b0:393:edbb:ab9d with SMTP id n5-20020a05600c3b8500b00393edbbab9dmr2751269wms.126.1651573611842; Tue, 03 May 2022 03:26:51 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p14-20020adfaa0e000000b0020c5253d8f6sm8868281wrd.66.2022.05.03.03.26.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 May 2022 03:26:50 -0700 (PDT) Message-Id: <3b944102ff28ca8d8b66ddac707a48252f0843b2.1651573607.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 03 May 2022 10:26:42 +0000 Subject: [PATCH v2 1/6] trace2 docs: a couple of grammar fixes Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Jeff Hostetler , Jeff Hostetler , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Johannes Schindelin Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Johannes Schindelin From: Johannes Schindelin Signed-off-by: Johannes Schindelin --- Documentation/technical/api-trace2.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt index bb13ca3db8b..adf867e1013 100644 --- a/Documentation/technical/api-trace2.txt +++ b/Documentation/technical/api-trace2.txt @@ -24,8 +24,8 @@ for example. Trace2 is controlled using `trace2.*` config values in the system and global config files and `GIT_TRACE2*` environment variables. Trace2 does -not read from repo local or worktree config files or respect `-c` -command line config settings. +not read from repo local or worktree config files, nor does it respect +`-c` command line config settings. == Trace2 Targets @@ -34,8 +34,8 @@ Format details are given in a later section. === The Normal Format Target -The normal format target is a tradition printf format and similar -to GIT_TRACE format. This format is enabled with the `GIT_TRACE2` +The normal format target is a traditional printf format and similar +to the GIT_TRACE format. This format is enabled with the `GIT_TRACE2` environment variable or the `trace2.normalTarget` system or global config setting. @@ -635,7 +635,7 @@ process may be a shell script which doesn't have a session-id.) + This event is generated after the child is started in the background and given a little time to boot up and start working. If the child -startups normally and while the parent is still waiting, the "ready" +starts up normally while the parent is still waiting, the "ready" field will have the value "ready". If the child is too slow to start and the parent times out, the field will have the value "timeout". @@ -949,7 +949,7 @@ atexit elapsed:3.868970 code:0 Regions:: - Regions can be use to time an interesting section of code. + Regions can be used to time an interesting section of code. + ---------------- void wt_status_collect(struct wt_status *s) @@ -1103,9 +1103,9 @@ Thread Events:: Thread messages added to a thread-proc. + -For example, the multithreaded preload-index code can be +For example, the multi-threaded preload-index code can be instrumented with a region around the thread pool and then -per-thread start and exit events within the threadproc. +per-thread start and exit events within the thread-proc. + ---------------- static void *preload_thread(void *_data) From patchwork Tue May 3 10:26:43 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Schindelin X-Patchwork-Id: 12835549 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A55F3C433F5 for ; Tue, 3 May 2022 10:27:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234114AbiECKac (ORCPT ); Tue, 3 May 2022 06:30:32 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45468 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233104AbiECKa3 (ORCPT ); Tue, 3 May 2022 06:30:29 -0400 Received: from mail-wm1-x32f.google.com (mail-wm1-x32f.google.com [IPv6:2a00:1450:4864:20::32f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D10D8E84 for ; Tue, 3 May 2022 03:26:54 -0700 (PDT) Received: by mail-wm1-x32f.google.com with SMTP id 129so9652676wmz.0 for ; Tue, 03 May 2022 03:26:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=Yae+hIRcjXLrQt0lyKLvVSmPN1iLZsCTIpUH/JeqsHo=; b=a+exiVV5ZpeLrxX9RdHKXMmfzev0i5MyTPQFY+ifrfk3o2MzlWElih1zEOgN6Fzt5S pvqnwSnYY3JPHYgyxtbRM5dftmW5iSecuaUwGEhk87HD44ENwslTMlcW+pJuPTUZeGfB Jl0TgcV7sorFPxUFR11FnyCs79njLGw/AF2ex5X+7ng4XItQ2rCjk/gxpkCJk3jt1u2k Kf77wDncogW/jBxDggtGO8PkRGFpsqNEmfnTROhkT7WolW1PT9NxNFgEh8RobmDqIZr0 wMM6tdNqxhyw/L++vW7z2intURmRYFHTGQ2PipVX9XeqR3gCB8ThIykt769+o58oJ4rY QWXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=Yae+hIRcjXLrQt0lyKLvVSmPN1iLZsCTIpUH/JeqsHo=; b=0Z6+i8diicAnAIAwz5Gbb/l49pQypBmB5Ed+/c+dhz6cNlM40UaZ7RCRvvQG7ORTnc 0l9o/rUJlqq4S6EAzQoh1fN0ilo7T8gOI96x90AKmb70Yi74Qdvl6ZvQ3DdNfdJFvG7N My3w2x+JZOp6HwJrUc3D/dRqVcpC7Q929yWlIf+Ywskr/dI8/PyaVTbF31KWxlDkIJYk Y3kaUNUhrH3twM1OVEkigbuDuqc93p8Iye2zc3KvIeL5jBJdx5InDBlUvZsQWKxvZ6Bl p1T9qTGdT1I0UPIxOdt9cPH4uFaphWZ4qqj6RtTwPMO5taPOECD0V604PPJC4N819por NwFw== X-Gm-Message-State: AOAM530eE0KgaioVht1H6YdcpIvRUFl35p5uZ7axOb3kBhplZoei4ZSp IdhuC0ZPaEmUZ8EpYHPOTwqsMgs9qJI= X-Google-Smtp-Source: ABdhPJyOXI7fImY/EZ5vIKZ0QlhIKPcJJAwZuvA3uJn4YahxoBTnjx4TwBwsnowSxyVRXG5NMiuUBA== X-Received: by 2002:a05:600c:3ca3:b0:392:990b:af11 with SMTP id bg35-20020a05600c3ca300b00392990baf11mr2716684wmb.173.1651573612973; Tue, 03 May 2022 03:26:52 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id u2-20020adfa182000000b0020c5253d915sm8999096wru.97.2022.05.03.03.26.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 May 2022 03:26:52 -0700 (PDT) Message-Id: <3c1ca34927a6634bcfaf444cf0712f74ac48311e.1651573607.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 03 May 2022 10:26:43 +0000 Subject: [PATCH v2 2/6] trace2 docs: "printf" is not an English word Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Jeff Hostetler , Jeff Hostetler , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Johannes Schindelin Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Johannes Schindelin From: Johannes Schindelin We append an ellipsis and enclose it in backticks to indicate that it is a function elsewhere, let's also use that here. While at it, ensure the same for `waitpid()`. Signed-off-by: Johannes Schindelin --- Documentation/technical/api-trace2.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt index adf867e1013..1f1a06eabc6 100644 --- a/Documentation/technical/api-trace2.txt +++ b/Documentation/technical/api-trace2.txt @@ -5,7 +5,7 @@ information to stderr or a file. The Trace2 feature is inactive unless explicitly enabled by enabling one or more Trace2 Targets. The Trace2 API is intended to replace the existing (Trace1) -printf-style tracing provided by the existing `GIT_TRACE` and +`printf()`-style tracing provided by the existing `GIT_TRACE` and `GIT_TRACE_PERFORMANCE` facilities. During initial implementation, Trace2 and Trace1 may operate in parallel. @@ -34,7 +34,7 @@ Format details are given in a later section. === The Normal Format Target -The normal format target is a traditional printf format and similar +The normal format target is a traditional `printf()` format and similar to the GIT_TRACE format. This format is enabled with the `GIT_TRACE2` environment variable or the `trace2.normalTarget` system or global config setting. @@ -234,7 +234,7 @@ Events are written as lines of the form: is the event name. ``:: - is a free-form printf message intended for human consumption. + is a free-form `printf()` message intended for human consumption. + Note that this may contain embedded LF or CRLF characters that are not escaped, so the event may spill across multiple lines. @@ -300,7 +300,7 @@ This field is in anticipation of in-proc submodules in the future. indicate a broad category, such as "index" or "status". ``:: - is a free-form printf message intended for human consumption. + is a free-form `printf()` message intended for human consumption. ------------ 15:33:33.532712 wt-status.c:2310 | d0 | main | region_enter | r1 | 0.126064 | | status | label:print @@ -588,7 +588,7 @@ with "?". `"child_exit"`:: This event is generated after the current process has returned - from the waitpid() and collected the exit information from the + from the `waitpid()` and collected the exit information from the child. + ------------ @@ -609,7 +609,7 @@ process may be a shell script which doesn't have a session-id.) + Note that the `t_rel` field contains the observed run time in seconds for the child process (starting before the fork/exec/spawn and -stopping after the waitpid() and includes OS process creation overhead). +stopping after the `waitpid()` and includes OS process creation overhead). So this time will be slightly larger than the atexit time reported by the child process itself. From patchwork Tue May 3 10:26:44 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Schindelin X-Patchwork-Id: 12835552 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 799C0C433EF for ; Tue, 3 May 2022 10:27:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234147AbiECKas (ORCPT ); Tue, 3 May 2022 06:30:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45496 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234070AbiECKaa (ORCPT ); Tue, 3 May 2022 06:30:30 -0400 Received: from mail-wr1-x432.google.com (mail-wr1-x432.google.com [IPv6:2a00:1450:4864:20::432]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D71FF26F3 for ; Tue, 3 May 2022 03:26:56 -0700 (PDT) Received: by mail-wr1-x432.google.com with SMTP id k2so22747338wrd.5 for ; Tue, 03 May 2022 03:26:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=f2zNf8f8AmMY58c6kV8zXESPkKP5CdvURxartU7hBY8=; b=KigVSK7uT6taAQNVm5onw0Hr8CmKKrnloc7Vcm3mNexFNN1S4tgbELyxfuC7m3Tw9m iONp6G5Ab+xk4y/9dmFYxbpYM1TrtfcgSTRf3JQw9SzZNqA++A/WEMgaLJvBJ7hxdVQ6 kThYWvtIpk5DY2kcafWJL9zQojRDW+zfdamrzx5tTDPvAWTyKIvUsDXzvtJPUf5LT0RD wUQt0vW65/NSEw3Xh4Aap8rDHTbOdHWUdqHFB71nBSYp5u+e//h8oM3BLi0+nETJWNxF df6txMZfxT+WMA5qsvf4hN7JUD4wPkD7EQDxsekdCUziztgEZFKZx0QArrhEIV35a4K2 dX8A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=f2zNf8f8AmMY58c6kV8zXESPkKP5CdvURxartU7hBY8=; b=ARyTjt4ND1bNGv043RUuCwSfCQM3k2y9Hne/JK4mWmMxcI00M0zAyHjtLgQVH9OOZf 0t4Kmme0txiLZN5UhU63lNuj9ucAeqIthh/gNuUkWaSgnJwVcLSrhc54mnPlOuyvYQQH 1cVMWtmzbm6FJD3z8mePBOAbyIqsWtShRV+1gTNpvYwwbnCuWriKRO2FzQLS6RGEqxIn BtnuDcLC00YKkWVjR03jCT7pW8S9VCEjlomOYDTcLsQf9IdP6oYCY+KlLBVWTmu0Mly1 FbEr8Iis/FE83m7zpOQoioauQH4jGcBwoUXYchlADJGh7d/3kL3wj7YhOU3fijAQxcNY /xKw== X-Gm-Message-State: AOAM533x8IFPDTqTr/r34nmAyAVlkvf77hzp67CeiJPepgl8ukgtn51/ Vlz0Vl2S2qaBBEiteU7svAGXBPnt8jM= X-Google-Smtp-Source: ABdhPJxgdZdFttDR/JET6lNBIIwkKcjIKI+pGhs5dLuuCoJ7Cwsi9UsX+iXzGzhSmYyHECmjyuJlxA== X-Received: by 2002:a05:6000:144f:b0:20c:6090:3040 with SMTP id v15-20020a056000144f00b0020c60903040mr7205899wrx.479.1651573614655; Tue, 03 May 2022 03:26:54 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f2-20020a7bcd02000000b003942a244f48sm1333062wmj.33.2022.05.03.03.26.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 May 2022 03:26:53 -0700 (PDT) Message-Id: <2ddd9ff4506475c44f68e14a4e0a9abce2806e3b.1651573607.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 03 May 2022 10:26:44 +0000 Subject: [PATCH v2 3/6] trace2 docs: surround more terms in backticks Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Jeff Hostetler , Jeff Hostetler , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Johannes Schindelin Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Johannes Schindelin From: Johannes Schindelin Signed-off-by: Johannes Schindelin --- Documentation/technical/api-trace2.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt index 1f1a06eabc6..e8a5d7c78d0 100644 --- a/Documentation/technical/api-trace2.txt +++ b/Documentation/technical/api-trace2.txt @@ -35,7 +35,7 @@ Format details are given in a later section. === The Normal Format Target The normal format target is a traditional `printf()` format and similar -to the GIT_TRACE format. This format is enabled with the `GIT_TRACE2` +to the `GIT_TRACE` format. This format is enabled with the `GIT_TRACE2` environment variable or the `trace2.normalTarget` system or global config setting. @@ -69,8 +69,8 @@ $ cat ~/log.normal === The Performance Format Target The performance format target (PERF) is a column-based format to -replace GIT_TRACE_PERFORMANCE and is suitable for development and -testing, possibly to complement tools like gprof. This format is +replace `GIT_TRACE_PERFORMANCE` and is suitable for development and +testing, possibly to complement tools like `gprof`. This format is enabled with the `GIT_TRACE2_PERF` environment variable or the `trace2.perfTarget` system or global config setting. @@ -172,7 +172,7 @@ take a `va_list` argument. Some functions have a `_printf_fl()` suffix to indicate that they also take a varargs argument. -There are CPP wrapper macros and ifdefs to hide most of these details. +There are CPP wrapper macros and `#ifdef`s to hide most of these details. See `trace2.h` for more details. The following discussion will only describe the simplified forms. @@ -1214,11 +1214,11 @@ as each thread starts and allocates TLS storage. There are a few issues to resolve before we can completely switch to Trace2. -* Updating existing tests that assume GIT_TRACE format messages. +* Updating existing tests that assume `GIT_TRACE` format messages. -* How to best handle custom GIT_TRACE_ messages? +* How to best handle custom `GIT_TRACE_` messages? -** The GIT_TRACE_ mechanism allows each to write to a +** The `GIT_TRACE_` mechanism allows each to write to a different file (in addition to just stderr). ** Do we want to maintain that ability or simply write to the existing From patchwork Tue May 3 10:26:45 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Schindelin X-Patchwork-Id: 12835553 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1CAC2C433EF for ; Tue, 3 May 2022 10:27:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234184AbiECKat (ORCPT ); Tue, 3 May 2022 06:30:49 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45500 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234076AbiECKaa (ORCPT ); Tue, 3 May 2022 06:30:30 -0400 Received: from mail-wm1-x330.google.com (mail-wm1-x330.google.com [IPv6:2a00:1450:4864:20::330]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 488D4644C for ; Tue, 3 May 2022 03:26:58 -0700 (PDT) Received: by mail-wm1-x330.google.com with SMTP id ay11-20020a05600c1e0b00b0038eb92fa965so1055527wmb.4 for ; Tue, 03 May 2022 03:26:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=MbE5fPZ6+QDkXvZT+FpmiJMxsnCjrY3txpRuLfM65hI=; b=gkUiKrjmqJwP8Dqo7DrImwerFcU1YjRfcGgyyGyRPXYSo7v1euw3/zc3eEpn5pyVsf thSyw+GuxJhc9HdrWCO++fWA24yXBvg6qq+18wYrMHrFcTQg1yLQ/STuM9Mrh523g5G7 vy32Tb4xtxLYOqJNeUQgFc7BarXaB/cAxQxHbCjeDaF68Gi4CyFI5dgbA18vX4QOXpK9 wOiUxCVzSmqmDodYEN6ys1VHQBjordWopP0YiHKuMeM6Tbl4yhtcD+8+z8ZIvHbDmBBy hnNAkVNK6LTOcagjq0MWSIlo5fF2CNpyqRIHL5n4HANfU67Pc5/1eL3iD5C+q4Cgdw8Y LDKQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=MbE5fPZ6+QDkXvZT+FpmiJMxsnCjrY3txpRuLfM65hI=; b=jVHRlFFVkLfJIslCRHcdVdhNezepOAGJPxnxkMaCF2x7thrbvM+g3yzvLOmArBtoVF tIyWMkwHX/SZvy6IgX/inpl6EtBlmTCQwe3yLQnWyHkSCuw5KIfcpllnRx4yvRRKiPBz KpFw17PdRa3mcvykDknwekdpyh+pNT5G6yQtT+4yQhkxv+o3FDWwmdmUYMaGYU+khnsc 1RXUe2wVHAcREaUOAW5EdpQFWsnKEZ5ua42tvAtEUXz6bcyAMjIGu5ZgmmBJSiDO1YZ/ RNMR1/4fLNPNfygb6HBoKHy9oZa5PlybBQhJDg8xhvCIZoqgnB5MAbpfT8ww9XuN/Lfn Nj2Q== X-Gm-Message-State: AOAM5314NutSGat4i3vwWM3e9ACep1NieB6J9PxYzJV5kAXQpJWjbEwn u/j1ik0Nv6fXaD+8iH2roooKZyrU2tc= X-Google-Smtp-Source: ABdhPJyecJwocBvGJLr2YgAPJ3g3uB6PSga0o3tRIDpisGnEb8caorh+KxTxbN2Mb/SN1pFShQ3XeQ== X-Received: by 2002:a05:600c:1c27:b0:393:ee3d:eb0a with SMTP id j39-20020a05600c1c2700b00393ee3deb0amr2749498wms.69.1651573616421; Tue, 03 May 2022 03:26:56 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id c18-20020a05600c0a5200b003942a244f43sm1406390wmq.28.2022.05.03.03.26.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 May 2022 03:26:55 -0700 (PDT) Message-Id: <1c5a700838201d7002351c8664b9a2c16a00688d.1651573607.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 03 May 2022 10:26:45 +0000 Subject: [PATCH v2 4/6] trace2 docs: fix a JSON formatted example Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Jeff Hostetler , Jeff Hostetler , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Johannes Schindelin Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Johannes Schindelin From: Johannes Schindelin The example was not in valid JSON format due to a duplicate key "sid". Signed-off-by: Johannes Schindelin --- Documentation/technical/api-trace2.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt index e8a5d7c78d0..bf0f0750733 100644 --- a/Documentation/technical/api-trace2.txt +++ b/Documentation/technical/api-trace2.txt @@ -128,7 +128,7 @@ yields ------------ $ cat ~/log.event -{"event":"version","sid":"sid":"20190408T191610.507018Z-H9b68c35f-P000059a8","thread":"main","time":"2019-01-16T17:28:42.620713Z","file":"common-main.c","line":38,"evt":"3","exe":"2.20.1.155.g426c96fcdb"} +{"event":"version","sid":"20190408T191610.507018Z-H9b68c35f-P000059a8","thread":"main","time":"2019-01-16T17:28:42.620713Z","file":"common-main.c","line":38,"evt":"3","exe":"2.20.1.155.g426c96fcdb"} {"event":"start","sid":"20190408T191610.507018Z-H9b68c35f-P000059a8","thread":"main","time":"2019-01-16T17:28:42.621027Z","file":"common-main.c","line":39,"t_abs":0.001173,"argv":["git","version"]} {"event":"cmd_name","sid":"20190408T191610.507018Z-H9b68c35f-P000059a8","thread":"main","time":"2019-01-16T17:28:42.621122Z","file":"git.c","line":432,"name":"version","hierarchy":"version"} {"event":"exit","sid":"20190408T191610.507018Z-H9b68c35f-P000059a8","thread":"main","time":"2019-01-16T17:28:42.621236Z","file":"git.c","line":662,"t_abs":0.001227,"code":0} From patchwork Tue May 3 10:26:46 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Schindelin X-Patchwork-Id: 12835551 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7D409C433EF for ; Tue, 3 May 2022 10:27:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234186AbiECKap (ORCPT ); Tue, 3 May 2022 06:30:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45520 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234081AbiECKab (ORCPT ); Tue, 3 May 2022 06:30:31 -0400 Received: from mail-wr1-x429.google.com (mail-wr1-x429.google.com [IPv6:2a00:1450:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9F203E75 for ; Tue, 3 May 2022 03:26:59 -0700 (PDT) Received: by mail-wr1-x429.google.com with SMTP id q23so22761761wra.1 for ; Tue, 03 May 2022 03:26:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=Z+SdrdfA82ej6bbOw4rrQsPd5k7rB2NP+NZoMPGkgnw=; b=Z2Zi3fsEF6IE5bdyDRkMr7tUwL87tazgf9YeAAiizhf9WcfOvBAJeU3IRIyEoQNmp8 Y+yiyID3at4N/XFoMHRyOl8be9iT0HiMBL5jwApZ5ObXA1kYn/DvJOxphBU+CiOIe1vy PPWCjDJINxNirCebw8vk9NW7D5a4QyhYWVMad8SI/apbFaH5gS7lxPrVe3fJRxyYkhjB 9P5VqrEHvUVezS9m5O3l+pq5BfjzQ0SLrlI92tNFwmlJS2i19dyG1gV5xNV1rl1luymn rAPzNd/YY6jm5T8tY5QTkotf0KF91DamU5/Izrx5LOvi7i5M7pmmcRO6/zf+IIChlaQH VuGA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=Z+SdrdfA82ej6bbOw4rrQsPd5k7rB2NP+NZoMPGkgnw=; b=ELWerOLX6YJnoPsl0ix7j4XDD6ejvxi5LfILzIH619DI2p1NohE3tsfdpYMLZckHbP dXp/gXPSbnu1ACpnYUDhUoSp555fL8lLy9T0R5wt99aYS8wLxgcxcnJobGf8lZtau4Wq OYYPvfgMRM0+O5HTkbyaAXD97lSmo0sE82SUGlQvIBYqN4t9iHz3+jS65SFaFlHVKQnL pETAyR8VgARUEZ66wD9uw6u/1bukQQaYIfP37FF6mM3pEG6eVYPw4pPpd2ukSUDhQrsZ cerUmqQ30WeGfqJb6JPEqkNrxqxbJeZO5Y8R/7xpUG+/tUMF4OCMzjPbnXSgpWpnB1kc e6og== X-Gm-Message-State: AOAM530mrAaR59PkatNSPFOj88sVczrQI38DTwOVxA1XkLWjT84e1s4v aYf4G42uN+YRHjnQT+XR1hxmrD2c3ic= X-Google-Smtp-Source: ABdhPJwes/mufNtCG/Yt6dkDj4e5tb6MkhJ69JYkGjk+bJxctZB7rQUMwFYVAYGiIiVYs0MLGCv6hw== X-Received: by 2002:a5d:6e8b:0:b0:207:861e:36cd with SMTP id k11-20020a5d6e8b000000b00207861e36cdmr12154616wrz.563.1651573617768; Tue, 03 May 2022 03:26:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id y8-20020adfc7c8000000b0020c5253d902sm9149192wrg.78.2022.05.03.03.26.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 May 2022 03:26:57 -0700 (PDT) Message-Id: <0c09fd000a6ee9827d78df8993e0310623f9fd56.1651573607.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Tue, 03 May 2022 10:26:46 +0000 Subject: [PATCH v2 5/6] trace2 docs: clarify what `varargs` is all about Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Jeff Hostetler , Jeff Hostetler , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Johannes Schindelin Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Johannes Schindelin From: Johannes Schindelin Signed-off-by: Johannes Schindelin --- Documentation/technical/api-trace2.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt index bf0f0750733..05fa38cf651 100644 --- a/Documentation/technical/api-trace2.txt +++ b/Documentation/technical/api-trace2.txt @@ -170,7 +170,7 @@ Some functions have a `_va_fl()` suffix to indicate that they also take a `va_list` argument. Some functions have a `_printf_fl()` suffix to indicate that they also -take a varargs argument. +take a `printf()` style format with a variable number of arguments. There are CPP wrapper macros and `#ifdef`s to hide most of these details. See `trace2.h` for more details. The following discussion will only From patchwork Tue May 3 10:26:47 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Johannes Schindelin X-Patchwork-Id: 12835550 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CDF32C433F5 for ; Tue, 3 May 2022 10:27:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234126AbiECKao (ORCPT ); Tue, 3 May 2022 06:30:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45578 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230251AbiECKah (ORCPT ); Tue, 3 May 2022 06:30:37 -0400 Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 75ED26559 for ; Tue, 3 May 2022 03:27:01 -0700 (PDT) Received: by mail-wr1-x42e.google.com with SMTP id w4so22702143wrg.12 for ; Tue, 03 May 2022 03:27:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=ezlkLv8fxnncOlJvMOA+dK5y6vHQPHrwwECYfys/UMk=; b=IipmY6PBKqEg6IYKK+uvoxAIIIq0rSajqD0M5deGBLAW/d7bhx3DZKJhwEioZrT38C k+xm7fh+NAzlFcW6Yr7OByumX8hmL8UWSDye1CWDnokLnCP1VDvj/afI8kItH/rnK5yc 743xMok518mhXR/q6tSVt0oqFuOOAicQMXySK8NL0crdoXsBXVbf1hcelmaxtGaZOtbG X18hv5G08CYZ96frSC9X1Kb8HZuGXpAS67XqTAIWHr0I0HY3QWSkW3iRnliyX0RD5Bp+ GBwyN1RAr0UbFnZ5e8z2AYeivMR2l0oyi+nkt1qvEpWj1Xi+21N6DvFzu40PaBGiepYh uiCQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=ezlkLv8fxnncOlJvMOA+dK5y6vHQPHrwwECYfys/UMk=; b=OUPzwi0OvR1c2NzT4D9GMAmxsJC2aPsz/5XbdD9g4PMIjiplD/BI66gk9/RjWwgaPn e8e/YY0kKhQkjcubvQZzyqNdHMAHFtaJu5I/3ybdLgVQvteWFkDbc3R7OknMQhm3blxK WgYielMheCIdJdwVY55/nLYGvT/1cR0c2cqLLeWLsyi4Q/CSoc4BemH9DsbFR2nZKEib buKYoDKeK9+9n0W0h3k7Z0ksiPUE86QfrGcdQ3ZhMbzmtwXhQ+MxunWVZ/zv0XKiuA9Q w3ZtRFAKtVLvvL+QGZK9MEP1WYvRku+0ASDSBahiVAkCCqBinctrL5BJXOC1RV9Ts36h F/wg== X-Gm-Message-State: AOAM533P5LMxo3I8OQhQe4+WkAi099f7gVicXjurQKDC7K3Ek9yqpb4o zE3CgXA5C2vAgvmWbBhZHBIuRkClOvM= X-Google-Smtp-Source: ABdhPJzzBaKwWcXzdumE3KwIXGoIYAvUbPe4OK3xQ+nGfWnbgkO6rQ6TP2/09z9Lx85bdkxLOu0g1w== X-Received: by 2002:a5d:6489:0:b0:20c:6b7d:1bab with SMTP id o9-20020a5d6489000000b0020c6b7d1babmr4657960wri.449.1651573619661; Tue, 03 May 2022 03:26:59 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id z14-20020a05600c03ce00b003942a244edfsm1284512wmd.36.2022.05.03.03.26.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 03 May 2022 03:26:58 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Tue, 03 May 2022 10:26:47 +0000 Subject: [PATCH v2 6/6] trace2 docs: add missing full stop Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Jeff Hostetler , Jeff Hostetler , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsA==?= Bjarmason , Johannes Schindelin , Johannes Schindelin Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: Johannes Schindelin From: Johannes Schindelin Signed-off-by: Johannes Schindelin --- Documentation/technical/api-trace2.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/technical/api-trace2.txt b/Documentation/technical/api-trace2.txt index 05fa38cf651..f4a8a690878 100644 --- a/Documentation/technical/api-trace2.txt +++ b/Documentation/technical/api-trace2.txt @@ -533,7 +533,7 @@ these special values are used: ------------ `"cmd_mode"`:: - This event, when present, describes the command variant This + This event, when present, describes the command variant. This event may be emitted more than once. + ------------