From mboxrd@z Thu Jan 1 00:00:00 1970 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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3BF55C54798 for ; Thu, 7 Mar 2024 20:53:36 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id A98D56B02B3; Thu, 7 Mar 2024 15:53:35 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id A49E86B02B4; Thu, 7 Mar 2024 15:53:35 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 8E9E76B02B5; Thu, 7 Mar 2024 15:53:35 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 7F2C26B02B3 for ; Thu, 7 Mar 2024 15:53:35 -0500 (EST) Received: from smtpin02.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id 59A09402BF for ; Thu, 7 Mar 2024 20:53:35 +0000 (UTC) X-FDA: 81871443990.02.ECCAC5C Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) by imf13.hostedemail.com (Postfix) with ESMTP id F2BAF2000B for ; Thu, 7 Mar 2024 20:53:32 +0000 (UTC) Authentication-Results: imf13.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b="TOvuaa/3"; dmarc=none; spf=none (imf13.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=rdunlap@infradead.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1709844813; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=p08jq4TIBI4zazg51JnXnjGH5Lu+du6lZuf9B2Rz4QQ=; b=mzUZ6aKuMMAuWAEF88BpP9IglYWYxpbtP8Gbm4ECyr1FwpObnsloeUgrJ/yHIfD4Ait/DV ZmH1nE5+1O10MqaVAxhKLl4KLJi7sAgikgkWYj9H2MlgOMY43e85X6MpbbmmQfDS3IMns7 hJ3sOtV2YPl7iZcFK2L229ppm2O9i7U= ARC-Authentication-Results: i=1; imf13.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b="TOvuaa/3"; dmarc=none; spf=none (imf13.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=rdunlap@infradead.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1709844813; a=rsa-sha256; cv=none; b=yjYokFqbnMtJNiuhPEt5hyIYBTzVGsQDQNSg76w+coj//byx+QTbIQXSHfGSxfV10yxL+o Y8al+DxUKMQvp6022ywHcqGF+omzRkQYO6ZjnyQMyghX1UXIhXEc7p09IJud730uuZI03t pwpl59/x/it78jcG2acUBiX5Wj0NMn0= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date: Message-ID:Sender:Reply-To:Content-ID:Content-Description; bh=p08jq4TIBI4zazg51JnXnjGH5Lu+du6lZuf9B2Rz4QQ=; b=TOvuaa/3wlEt4HaASAp9xkKucG +PY7MI+cX1hSmkmfFLvtR4JkMMdWfcVn8YtHQDGiMS3PJt7AA09NmwT0+GjU4w7EvTcYU989bq3lA Sh6H3anq6UeJdG7s5+p9HZ3DirzhzdP4JpB9MphGl6IsZAH4dOfsdtbzZJkSRJLswWFYPpauuyfXA Sfzyecd0rAcXOKsin/ZW2uEow+r/lYb/9BCfKH8o5Krry/ndFvOqVqSjHrnsABA9QpX6LO/lLNPn5 mwcOKE/wR1613yI+3HUvjJwhhHwu/dOn5jZGJybhQAfPSWpxxpf3MHsWmV/YP2TEMLCSl1X1YJmQp aZy2ZdFg==; Received: from [50.53.50.0] (helo=[192.168.254.15]) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1riKjl-00000006Lv6-1biU; Thu, 07 Mar 2024 20:53:09 +0000 Message-ID: <25a03dba-8d6b-4072-beae-7ea477fccbcb@infradead.org> Date: Thu, 7 Mar 2024 12:53:06 -0800 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v5 37/37] memprofiling: Documentation Content-Language: en-US To: John Hubbard , Kent Overstreet Cc: Suren Baghdasaryan , akpm@linux-foundation.org, mhocko@suse.com, vbabka@suse.cz, hannes@cmpxchg.org, roman.gushchin@linux.dev, mgorman@suse.de, dave@stgolabs.net, willy@infradead.org, liam.howlett@oracle.com, penguin-kernel@i-love.sakura.ne.jp, corbet@lwn.net, void@manifault.com, peterz@infradead.org, juri.lelli@redhat.com, catalin.marinas@arm.com, will@kernel.org, arnd@arndb.de, tglx@linutronix.de, mingo@redhat.com, dave.hansen@linux.intel.com, x86@kernel.org, peterx@redhat.com, david@redhat.com, axboe@kernel.dk, mcgrof@kernel.org, masahiroy@kernel.org, nathan@kernel.org, dennis@kernel.org, tj@kernel.org, muchun.song@linux.dev, rppt@kernel.org, paulmck@kernel.org, pasha.tatashin@soleen.com, yosryahmed@google.com, yuzhao@google.com, dhowells@redhat.com, hughd@google.com, andreyknvl@gmail.com, keescook@chromium.org, ndesaulniers@google.com, vvvvvv@google.com, gregkh@linuxfoundation.org, ebiggers@google.com, ytcoode@gmail.com, vincent.guittot@linaro.org, dietmar.eggemann@arm.com, rostedt@goodmis.org, bsegall@google.com, bristot@redhat.com, vschneid@redhat.com, cl@linux.com, penberg@kernel.org, iamjoonsoo.kim@lge.com, 42.hyeyoo@gmail.com, glider@google.com, elver@google.com, dvyukov@google.com, shakeelb@google.com, songmuchun@bytedance.com, jbaron@akamai.com, aliceryhl@google.com, rientjes@google.com, minchan@google.com, kaleshsingh@google.com, kernel-team@android.com, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, iommu@lists.linux.dev, linux-arch@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org, linux-modules@vger.kernel.org, kasan-dev@googlegroups.com, cgroups@vger.kernel.org References: <20240306182440.2003814-1-surenb@google.com> <20240306182440.2003814-38-surenb@google.com> <10a95079-86e4-41bf-8e82-e387936c437d@infradead.org> <72bbe76c-fcf9-47c2-b583-63d5ad77b3c3@nvidia.com> From: Randy Dunlap In-Reply-To: <72bbe76c-fcf9-47c2-b583-63d5ad77b3c3@nvidia.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: F2BAF2000B X-Rspam-User: X-Rspamd-Server: rspam02 X-Stat-Signature: ukk4gjb8gmpkun339kb6fe1rbdbsp1yu X-HE-Tag: 1709844812-617656 X-HE-Meta: U2FsdGVkX1+yqGPCCA6Bi4iRFeOwrh+kdH1TTZohAowWTbrliek7hiTFnJ2OeON4qVNkLyuYIO/WQr6VmhRHoke0xtXcjW8DNgGL7BOPARGmA44HP5+Px6DkJZjB9lBU9UBJf0YZLWpt+6tQkYge8VXnZV7vojvxxV62pxIHeZvIg4ArJYm/ucUjmOkmMnhH9fjDlwF5fjVtBWZJ3/RXMkAt+fVFgQkA7oVaJowSdeNCT9xRzclxLzhn+4x9HK5eEC9yV8odzKs5v/ydkdFquBGbtCbGfWTWYhHB9tZU310iaMOq8DOVbE1gLHkGlnBVgD2uzykkK2LOZ0DhjqBV2kTT1pQHXdDGHz7Aipa02JeMF+gazx8L0uxsbyDxKGWh8HeHdiSzOiOHMlaIEkMk+W5pHhaXrucGgfQ7lxCitWTL0/nzjSX1sofB0VHmOaQR7+mbb/fshJOydXpZbRkINYh9jaDh8uj5yuDoWotexAKp7KZLzr2+FrEPYwgJGIo8HK/KMyv3ClkGQ3SdkYJsEwdfMXPZi1uuZQ2Jo/iE7qC3USW8R0wlYE9yHH6QCX4cRIvHkqzjzK9rOk6J4H5hDx6di1FVu1SdswSrpCxdQz2ZjA5x6qkInIieW0kKcClrqLCRSi//Ev4ERmScDxabVrzrJHm4jWpiGZHEQxPGdTH8qjOOvtZ11n0yuU93JAYLJh57m5mfUiezfH6qdbyci1OnTnnpZgjwfjRRiSTyX0H3OQH5shoLD6Gc0b0Cx+UAP/h1aBB/W7VQe8Pv87GtPOSaFtwuyHXajffO3lfQxjKTuDB5L08cyEoliBDIRbc7imExwP3EA/HDLpq0HfycJLUqFYLmnd5LfmBd/DtglYq0jKLx8xgFtr+w26NbTCRq5hVpy8wNBmCYsFGte8mX3MJTjsQBKo7OxETtyrAlF3cT1/RkBes3FNnxdI+dpJaU3tT52PrThfxjn2cXSMm tcF7j79Z 7EsmiJKRYWLfwrIBJoESW/Qppkp8s3VDMCZa6cyD/JoeYsNWH5tOXkiwnskI738ZKNUQqb05+e4KfaBOFhE+HwCpoj2bYZu0r10v4W5IRLfOjtOvEmz0tPEBLuFnVlSc/dtuTEZqc+PAnPyq6aSSkKhegQgmlAA17PccGzBShxg1pljSr35dLAqSXb24QyoPIIHHVZNg6HkD5fBtko5p8EB5WbqK/wWXzYRWJgzldbO499hKHR9uD0+sj06t1u49pb0b+a73qUZRKyMIQh0rE7BoM/lrQmXsc4O5ivIkO7gExy57BMOQK8jZggw== X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: On 3/7/24 12:15, John Hubbard wrote: > On 3/7/24 12:03, Randy Dunlap wrote: >> On 3/7/24 10:17, Kent Overstreet wrote: >>> On Wed, Mar 06, 2024 at 07:18:57PM -0800, Randy Dunlap wrote: > ... >>>>> +- i.e. iterating over them to print them in debugfs/procfs. >>>> >>>>    i.e., iterating >>> >>> i.e. latin id est, that is: grammatically my version is fine >>> >> >> Some of my web search hits say that a comma is required after "i.e.". >> At least one of them says that it is optional. >> And one says that it is not required in British English. >> >> But writing it with "that is": >> >> >> hence code tagging) and then finding and operating on them at runtime >> - that is iterating over them to print them in debugfs/procfs. >> >> is not good IMO. But it's your document. >> > > Technical writing often benefits from a small amount redundancy. Short > sentences and repetition of terms are helpful to most readers. And this > also stays out of the more advanced grammatical constructs, as a side > effect. > > So, for example, something *approximately* like this, see what you > think: > > Memory allocation profiling is based upon code tagging. Code tagging is > a library for declaring static structs (typically by associating a file > and line number with a descriptive string), and then finding and > operating on those structs at runtime. Memory allocation profiling's > runtime operation is simply: print the structs via debugfs/procfs. Works for me. Thanks. -- #Randy