diff mbox series

Fixed case issue with 'fault-injection' in documentation

Message ID tencent_3EA07E65C43816C2A8402DC655CF98916B06@qq.com
State New
Headers
Series Fixed case issue with 'fault-injection' in documentation |

Commit Message

Ran.Park Feb. 14, 2024, 11:40 a.m. UTC 
  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.

Signed-off-by: Ran.Park <ranpark@foxmail.com>
---
 Documentation/fault-injection/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Ricardo B. Marliere Feb. 14, 2024, 1:13 p.m. UTC | #1 
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.

> 
> Signed-off-by: Ran.Park <ranpark@foxmail.com>
> ---
>  Documentation/fault-injection/index.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> 
> ────────────────────────────────────────────────────────────────────────────────
> modified: Documentation/fault-injection/index.rst
> ────────────────────────────────────────────────────────────────────────────────
> @ Documentation/fault-injection/index.rst:4 @
> .. SPDX-License-Identifier: GPL-2.0
> 
> ===============
> fault-injection
> Fault-injection
> ===============
> 
> .. toctree::
> - 
> 2.34.1
> 
>
Ran.Park Feb. 16, 2024, 5:28 a.m. UTC | #2 
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 problem 
on lore.kernel.org or other places. Should I mention the situation elsewhere 
and then resend the patch to mention and fix the problem.
Lukas Bulwahn Feb. 16, 2024, 6:19 a.m. UTC | #3 
On Fri, Feb 16, 2024 at 6:29 AM Ran.Park <ranpark@foxmail.com> wrote:
>
> 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 problem
> on lore.kernel.org or other places. Should I mention the situation elsewhere
> 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 PM 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
Jonathan Corbet Feb. 19, 2024, 9:36 p.m. UTC | #4 
Lukas Bulwahn <lukas.bulwahn@gmail.com> writes:

> 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?

This all seems like a bit much for what is essentially a typo fix.  I
would be amazed if it changed the build in any way other than making the
case more consistent; there's no need to do all that stuff.

I've applied it, thanks.

jon
diff mbox series

Patch

diff --git a/Documentation/fault-injection/index.rst b/Documentation/fault-injection/index.rst
index 8408a8a91b34..a6ea1d190222 100644
--- a/Documentation/fault-injection/index.rst
+++ b/Documentation/fault-injection/index.rst
@@ -1,7 +1,7 @@ 
 .. SPDX-License-Identifier: GPL-2.0
 
 ===============
-fault-injection
+Fault-injection
 ===============
 
 .. toctree::