Re: [PATCH v1 01/30] docs: reporting-issues: mention text is best viewed rendered
On 10/27/25 18:18, Jonathan Corbet wrote: > Thorsten Leemhuis writes: > >> Add a comment before the step-by-step guide explaining that the document >> is best viewed in the rendered form, as there the internal links will >> work that later patches will add. >> >> While at it change the double quotes in the license hint at the end of >> the document into single quotes, which is the preferred style. > > That is the classic marker of an independent change, of course. Yeah, I tried to not split things up too much. But that doesn't matter now anyway: > But > more significantly ... "preferred" by who? Double quotes are the normal > English style that folks like me learned many years ago... I removed those changes after that comment and Randy's NAK; I think I miss-interpreted or miss-remembered a comment in a review a while ago. > Otherwise seems OK. Thx! Ciao, Thorsten
Re: [PATCH v1 01/30] docs: reporting-issues: mention text is best viewed rendered
On 10/26/25 5:41 AM, Thorsten Leemhuis wrote: > Add a comment before the step-by-step guide explaining that the document > is best viewed in the rendered form, as there the internal links will > work that later patches will add. > > While at it change the double quotes in the license hint at the end of > the document into single quotes, which is the preferred style. > > Signed-off-by: Thorsten Leemhuis > --- > Documentation/admin-guide/reporting-issues.rst | 18 ++ > 1 file changed, 14 insertions(+), 4 deletions(-) > > diff --git a/Documentation/admin-guide/reporting-issues.rst > b/Documentation/admin-guide/reporting-issues.rst > index a68e6d90927471..3bc47afaf85ea0 100644 > --- a/Documentation/admin-guide/reporting-issues.rst > +++ b/Documentation/admin-guide/reporting-issues.rst > @@ -48,6 +48,16 @@ Once the report is out, answer any questions that come up > and help where you > can. That includes keeping the ball rolling by occasionally retesting with > newer > releases and sending a status update afterwards. > > +.. > + Note: If you see this note, you are reading the text's source file. You > + might want to switch to a rendered version: It makes it a lot easier to > + read and navigate this document -- especially when you want to look > something > + up in the reference section, then jump back to where you left off. > +.. > + Find the latest rendered version of this text here: > + https://docs.kernel.org/admin-guide/reporting-issues.html > + > + > Step-by-step guide how to report issues to the kernel maintainers > = > > @@ -1748,13 +1758,13 @@ art will lay some groundwork to improve the situation > over time. > you spot a typo or small mistake, feel free to let him know directly and > he'll fix it. You are free to do the same in a mostly informal way if you > want to contribute changes to the text, but for copyright reasons please > CC > - [email protected] and "sign-off" your contribution as > - Documentation/process/submitting-patches.rst outlines in the section "Sign > - your work - the Developer's Certificate of Origin". > + [email protected] and 'sign-off' your contribution as > + Documentation/process/submitting-patches.rst outlines in the section 'Sign > + your work - the Developer's Certificate of Origin'. Can you have a single quote (Developer's) inside single quotes? Anyway, nack on the quote marks changes. > .. > This text is available under GPL-2.0+ or CC-BY-4.0, as stated at the top > of the file. If you want to distribute this text under CC-BY-4.0 only, > - please use "The Linux kernel developers" for author attribution and link > + please use 'The Linux kernel developers' for author attribution and link > this as source: > > https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/admin-guide/reporting-issues.rst > .. -- ~Randy
Re: [PATCH v1 01/30] docs: reporting-issues: mention text is best viewed rendered
Thorsten Leemhuis writes: > Add a comment before the step-by-step guide explaining that the document > is best viewed in the rendered form, as there the internal links will > work that later patches will add. > > While at it change the double quotes in the license hint at the end of > the document into single quotes, which is the preferred style. That is the classic marker of an independent change, of course. But more significantly ... "preferred" by who? Double quotes are the normal English style that folks like me learned many years ago... > Signed-off-by: Thorsten Leemhuis > --- > Documentation/admin-guide/reporting-issues.rst | 18 ++ > 1 file changed, 14 insertions(+), 4 deletions(-) Otherwise seems OK. jon
[PATCH v1 01/30] docs: reporting-issues: mention text is best viewed rendered
Add a comment before the step-by-step guide explaining that the document is best viewed in the rendered form, as there the internal links will work that later patches will add. While at it change the double quotes in the license hint at the end of the document into single quotes, which is the preferred style. Signed-off-by: Thorsten Leemhuis --- Documentation/admin-guide/reporting-issues.rst | 18 ++ 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst index a68e6d90927471..3bc47afaf85ea0 100644 --- a/Documentation/admin-guide/reporting-issues.rst +++ b/Documentation/admin-guide/reporting-issues.rst @@ -48,6 +48,16 @@ Once the report is out, answer any questions that come up and help where you can. That includes keeping the ball rolling by occasionally retesting with newer releases and sending a status update afterwards. +.. + Note: If you see this note, you are reading the text's source file. You + might want to switch to a rendered version: It makes it a lot easier to + read and navigate this document -- especially when you want to look something + up in the reference section, then jump back to where you left off. +.. + Find the latest rendered version of this text here: + https://docs.kernel.org/admin-guide/reporting-issues.html + + Step-by-step guide how to report issues to the kernel maintainers = @@ -1748,13 +1758,13 @@ art will lay some groundwork to improve the situation over time. you spot a typo or small mistake, feel free to let him know directly and he'll fix it. You are free to do the same in a mostly informal way if you want to contribute changes to the text, but for copyright reasons please CC - [email protected] and "sign-off" your contribution as - Documentation/process/submitting-patches.rst outlines in the section "Sign - your work - the Developer's Certificate of Origin". + [email protected] and 'sign-off' your contribution as + Documentation/process/submitting-patches.rst outlines in the section 'Sign + your work - the Developer's Certificate of Origin'. .. This text is available under GPL-2.0+ or CC-BY-4.0, as stated at the top of the file. If you want to distribute this text under CC-BY-4.0 only, - please use "The Linux kernel developers" for author attribution and link + please use 'The Linux kernel developers' for author attribution and link this as source: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/admin-guide/reporting-issues.rst .. -- 2.51.0
