Thank you for working to improve our documentation! I have a few
comments on this patch, though.
Please use scripts/get_maintainer.pl to generate the proper recipient
list for a patch. I have added Thorsten, the author of the document you
are modifying, to the CC list here. I am curious as to what led you to
add trivial@xxxxxxxxxx? We have not encouraged use of that address for
some years.
Please also consider your subject line; "LFX Task" is not meaningful to
anybody else, and will help nobody in the kernel change history.
> From: SurajSonawane2415 <sonawanesr2012@xxxxxxxxx>
>
> 1. Corrected the sentence structure in several places for clarity and readability:
> Original: "those are described below the step-by-step guide"
> Corrected: "those are described below in the step-by-step guide"
>
> 2. Fixed grammatical errors:
> Original: "That why your might need to uninstall the packages with such software to get rid of any 3rd party kernel module."
> Corrected: "That’s why you might need to uninstall the packages with such software to get rid of any 3rd party kernel module."
>
> 3. Improved phrasing:
> Original: "might not what you want."
> Corrected: "might not be what you want."
>
> 4. Clarified instructions:
> Original: "Instead try search terms like the model line"
> Corrected: "Instead, try searching terms like the model line."
>
> These changes ensure that the documentation is more readable and accurate.
There is no need to repeat all of the changes here - we can see those in
the patch itself.
> Signed-off-by: Suraj Sonawane <surajsonawane0215@xxxxxxxxx>
> ---
> Documentation/admin-guide/reporting-issues.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
> index 2fd5a0302..e68c1f8f1 100644
> --- a/Documentation/admin-guide/reporting-issues.rst
> +++ b/Documentation/admin-guide/reporting-issues.rst
> @@ -56,7 +56,7 @@ developers. It might be all that's needed for people already familiar with
> reporting issues to Free/Libre & Open Source Software (FLOSS) projects. For
> everyone else there is this section. It is more detailed and uses a
> step-by-step approach. It still tries to be brief for readability and leaves
> -out a lot of details; those are described below the step-by-step guide in a
> +out a lot of details; those are described below in the step-by-step guide in a
> reference section, which explains each of the steps in more detail.
>
> Note: this section covers a few more aspects than the TL;DR and does things in
> @@ -299,7 +299,7 @@ face, even if they look small or totally unrelated. That's why you should report
> issues with these kernels to the vendor. Its developers should look into the
> report and, in case it turns out to be an upstream issue, fix it directly
> upstream or forward the report there. In practice that often does not work out
> -or might not what you want. You thus might want to consider circumventing the
> +or might not be what you want. You thus might want to consider circumventing the
> vendor by installing the very latest Linux kernel core yourself. If that's an
> option for you move ahead in this process, as a later step in this guide will
> explain how to do that once it rules out other potential causes for your issue.
> @@ -353,7 +353,7 @@ come up with other words to use as search terms. Also make sure not to use too
> many search terms at once. Remember to search with and without information like
> the name of the kernel driver or the name of the affected hardware component.
> But its exact brand name (say 'ASUS Red Devil Radeon RX 5700 XT Gaming OC')
> -often is not much helpful, as it is too specific. Instead try search terms like
> +often is not much helpful, as it is too specific. Instead, try searching terms like
I am not convinced this change improves things; the document is
suggesting the sort of search terms that might be useful.
> the model line (Radeon 5700 or Radeon 5000) and the code name of the main chip
> ('Navi' or 'Navi10') with and without its manufacturer ('AMD').
>
> @@ -472,7 +472,7 @@ before proceeding.
> Note, you might not be aware that your system is using one of these solutions:
> they often get set up silently when you install Nvidia's proprietary graphics
> driver, VirtualBox, or other software that requires a some support from a
> -module not part of the Linux kernel. That why your might need to uninstall the
> +module not part of the Linux kernel. That's why you might be need to uninstall the
> packages with such software to get rid of any 3rd party kernel module.
Otherwise the actual changes look good.
Thanks,
jon
