Re: [PATCH v2] docs: Fix typo in comment

From: William Breathitt Gray <william.gray@linaro.org>
To: Joe Perches <joe@perches.com>
Cc: Baoquan He <bhe@redhat.com>, Randy Dunlap <rdunlap@infradead.org>,
	Jonathan Corbet <corbet@lwn.net>, Slark Xiao <slark_xiao@163.com>,
	kafai <kafai@fb.com>, vgoyal <vgoyal@redhat.com>,
	dyoung <dyoung@redhat.com>, ast <ast@kernel.org>,
	daniel <daniel@iogearbox.net>, andrii <andrii@kernel.org>,
	"martin.lau" <martin.lau@linux.dev>, song <song@kernel.org>,
	yhs <yhs@fb.com>, "john.fastabend" <john.fastabend@gmail.com>,
	kpsingh <kpsingh@kernel.org>, sdf <sdf@google.com>,
	haoluo <haoluo@google.com>, jolsa <jolsa@kernel.org>,
	dhowells <dhowells@redhat.com>, peterz <peterz@infradead.org>,
	mingo <mingo@redhat.com>, will <will@kernel.org>,
	longman <longman@redhat.com>, "boqun.feng" <boqun.feng@gmail.com>,
	tglx <tglx@linutronix.de>, bigeasy <bigeasy@linutronix.de>,
	kexec <kexec@lists.infradead.org>,
	linux-doc <linux-doc@vger.kernel.org>,
	linux-kernel <linux-kernel@vger.kernel.org>,
	bpf <bpf@vger.kernel.org>,
	linux-cachefs <linux-cachefs@redhat.com>
Subject: Re: [PATCH v2] docs: Fix typo in comment
Date: Mon, 25 Jul 2022 09:57:04 -0400	[thread overview]
Message-ID: <Yt6hMD+HIaERgrqg@fedora> (raw)
In-Reply-To: <5bd85a7241e6ccac7fe5647cb9cf7ef22b228943.camel@perches.com>

[-- Attachment #1: Type: text/plain, Size: 1846 bytes --]

On Mon, Jul 25, 2022 at 06:52:15AM -0700, Joe Perches wrote:
> On Fri, 2022-07-22 at 07:45 +0800, Baoquan He wrote:
> > On 07/21/22 at 11:40am, Randy Dunlap wrote:
> > > On 7/21/22 11:36, Jonathan Corbet wrote:
> > > > "Slark Xiao" <slark_xiao@163.com> writes:
> > > > > May I know the maintainer of one subsystem could merge the changes
> > > > > contains lots of subsystem?  I also know this could be filtered by
> > > > > grep and sed command, but that patch would have dozens of maintainers
> > > > > and reviewers.
> > > > 
> > > > Certainly I don't think I can merge a patch touching 166 files across
> > > > the tree.  This will need to be broken down by subsystem, and you may
> > > > well find that there are some maintainers who don't want to deal with
> > > > this type of minor fix.
> > > 
> > > We have also seen cases where "the the" should be replaced by "then the"
> > > or some other pair of words, so some of these changes could fall into
> > > that category.
> > 
> > It's possible. I searched in Documentation and went through each place,
> > seems no typo of "then the". Below patch should clean up all the 'the the'
> > typo under Documentation.
> []
> > The fix is done with below command:
> > sed -i "s/the the /the /g" `git grep -l "the the " Documentation`
> 
> This command misses entries at EOL:
> 
> Documentation/trace/histogram.rst:  Here's an example where we use a compound key composed of the the
> 
> Perhaps a better conversion would be 's/\bthe the\b/the/g'

It would be good to check for instances that cross newlines as well;
i.e. "the" at the end of a line followed by "the" at the start of the
next line. However, this would require some thought to properly account
for comment blocks ("*") and other similar prefixes that should be
ignored.

William Breathitt Gray

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]