Received-SPF: pass (google.com: domain of linux-kernel+bounces-68093-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Precedence: bulk
MIME-Version: 1.0
References: <piosq44nxwlfeutperrk6d23bx564qlbfirc5xlbouyrunf24r@u6qsgqp47fz6> <tencent_B08771190400813E0CC41E36A3F540AACA07@qq.com>
In-Reply-To: <tencent_B08771190400813E0CC41E36A3F540AACA07@qq.com>
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date: Fri, 16 Feb 2024 07:19:23 +0100
Message-ID: <CAKXUXMy8WZwAqrARe-6nNhtvjSiosDD3X5aPZPfn7GXtkG8B8w@mail.gmail.com>
Subject: Re: [PATCH] Fixed case issue with 'fault-injection' in documentation
To: "Ran.Park" <ranpark@foxmail.com>
Cc: ricardo@marliere.net, akinobu.mita@gmail.com, corbet@lwn.net, 
	linux-doc@vger.kernel.org, linux-kernel-mentees@lists.linuxfoundation.org, 
	linux-kernel@vger.kernel.org, skhan@linuxfoundation.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Fri, Feb 16, 2024 at 6:29=E2=80=AFAM Ran.Park <ranpark@foxmail.com> wrot=
e:
>
> Thank you for your reply. I'm sorry that I noticed this problem
> while browsing the document. I have not seen any report about this proble=
m
> on lore.kernel.org or other places. Should I mention the situation elsewh=
ere
> and then resend the patch to mention and fix the problem.
>

Ran, in the future: please do not remove the context when you reply to
somebody's email.

In this case, I wanted to help you to understand what Ricardo was
asking, but his original response was not in your email. So, I copy
and pasted it now---but that is not how it is supposed to be for
someone replying to your email.

On Wed, Feb 14, 2024 at 2:21=E2=80=AFPM Ricardo B. Marliere
<ricardo@marliere.net> wrote:
>
> Hi Ran,
>
> On 14 Feb 19:40, Ran.Park wrote:
> > In the 'fault-injection' subdirectory, the first letter F
> > is capitalized, whereas in index.rst f is lowercase, but in
> > index.rst all other elements in the same column are capitalized.
>
> Does this fix any error or build warning? If so, it should be mentioned.
>

Ricardo suggests that:

- you run 'make htmldocs' before applying the patch and check for the
existing warnings.

- you run 'make cleandocs' and 'make htmldocs' after applying the
patch and check for the existing warnings.

Did any warning disappear or appear due to your patch? Were you
motivated by a specific warning you observed during the build and you
addressing that?

So, for starters: did you already try 'make htmldocs' with your patch
applied? What did you observe?


Lukas