linux-kernel - Re: [PATCH v5 37/37] memprofiling: Documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Thu, 7 Mar 2024 12:15:54 -0800
From: John Hubbard <jhubbard@...dia.com>
To: Randy Dunlap <rdunlap@...radead.org>,
 Kent Overstreet <kent.overstreet@...ux.dev>
Cc: Suren Baghdasaryan <surenb@...gle.com>, akpm@...ux-foundation.org,
 mhocko@...e.com, vbabka@...e.cz, hannes@...xchg.org,
 roman.gushchin@...ux.dev, mgorman@...e.de, dave@...olabs.net,
 willy@...radead.org, liam.howlett@...cle.com,
 penguin-kernel@...ove.sakura.ne.jp, corbet@....net, void@...ifault.com,
 peterz@...radead.org, juri.lelli@...hat.com, catalin.marinas@....com,
 will@...nel.org, arnd@...db.de, tglx@...utronix.de, mingo@...hat.com,
 dave.hansen@...ux.intel.com, x86@...nel.org, peterx@...hat.com,
 david@...hat.com, axboe@...nel.dk, mcgrof@...nel.org, masahiroy@...nel.org,
 nathan@...nel.org, dennis@...nel.org, tj@...nel.org, muchun.song@...ux.dev,
 rppt@...nel.org, paulmck@...nel.org, pasha.tatashin@...een.com,
 yosryahmed@...gle.com, yuzhao@...gle.com, dhowells@...hat.com,
 hughd@...gle.com, andreyknvl@...il.com, keescook@...omium.org,
 ndesaulniers@...gle.com, vvvvvv@...gle.com, gregkh@...uxfoundation.org,
 ebiggers@...gle.com, ytcoode@...il.com, vincent.guittot@...aro.org,
 dietmar.eggemann@....com, rostedt@...dmis.org, bsegall@...gle.com,
 bristot@...hat.com, vschneid@...hat.com, cl@...ux.com, penberg@...nel.org,
 iamjoonsoo.kim@....com, 42.hyeyoo@...il.com, glider@...gle.com,
 elver@...gle.com, dvyukov@...gle.com, shakeelb@...gle.com,
 songmuchun@...edance.com, jbaron@...mai.com, aliceryhl@...gle.com,
 rientjes@...gle.com, minchan@...gle.com, kaleshsingh@...gle.com,
 kernel-team@...roid.com, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, iommu@...ts.linux.dev,
 linux-arch@...r.kernel.org, linux-fsdevel@...r.kernel.org,
 linux-mm@...ck.org, linux-modules@...r.kernel.org,
 kasan-dev@...glegroups.com, cgroups@...r.kernel.org
Subject: Re: [PATCH v5 37/37] memprofiling: Documentation

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.




thanks,
-- 
John Hubbard
NVIDIA