On 13.08.24 19:32, Jonathan Corbet wrote:
> Thank you for working to improve our documentation! I have a few
> comments on this patch, though.
Yeah, many thx for this! Two quick additional comments from my side:
> [...]
>> 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
> [...]
>> @@ -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.
I'm not a native speaker, but I think Jonathan is right here.
Furthermore: I'm not sure how strict we handle the 80 character limit in
the docs these days, but this document follows it, except in a few
carefully chosen places where that would be odd or confusing. This
change breaks with that approach. Given that this individual change
likely will be dropped this is not much of a problem, but...
>> 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
...the same problem happens here.
Ciao, Thorsten
