Received-SPF: pass (google.com: domain of linux-kernel+bounces-96222-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Message-ID: <25a03dba-8d6b-4072-beae-7ea477fccbcb@infradead.org>
Date: Thu, 7 Mar 2024 12:53:06 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v5 37/37] memprofiling: Documentation
Content-Language: en-US
To: John Hubbard <jhubbard@nvidia.com>,
 Kent Overstreet <kent.overstreet@linux.dev>
Cc: Suren Baghdasaryan <surenb@google.com>, 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>
 <hsyclfp3ketwzkebjjrucpb56gmalixdgl6uld3oym3rvssyar@fmjlbpdkrczv>
 <f12e83ef-5881-4df8-87ae-86f8ca5a6ab4@infradead.org>
 <72bbe76c-fcf9-47c2-b583-63d5ad77b3c3@nvidia.com>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <72bbe76c-fcf9-47c2-b583-63d5ad77b3c3@nvidia.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit


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