[PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst
Remove the WIP and two FIXME notes in the text to make it official, as it's now considered fully ready for consumption. To make sure this step is okay for people the intent of this change and the latest version of the text were posted to ksummit-discuss; nobody complained, thus lets move ahead. Add a footer to point out people can contact Thorsten directly in case they find something to improve in the text. Dear reporting-bugs.rst, I'm sorry to tell you, but that makes you fully obsolete and we thus have to let you go now. Thank you very much for your service, you in one form or another have been around for a long time. I'm sure over the years you got read a lot and helped quite a few people. But it's time to retire now. Rest in peace. Signed-off-by: Thorsten Leemhuis CC: Harry Wei CC: Alex Shi CC: Federico Vaga CC: Greg KH --- Removing Documentation/admin-guide/reporting-bugs.rst will break links in some of the translations. I was unsure if simply changing them to Documentation/admin-guide/reporting-issue.rst was wise, so I didn't touch anything for now and CCed the maintainers for the Chinese and Italian translation. I couldn't find one for the Japanse translation. Please advice. For completeness, this are the places where things will break afaics: $ grep -ri 'reporting-bugs.rst' Documentation/ Documentation/translations/zh_CN/SecurityBugs:是有帮助的信息，那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任 Documentation/translations/zh_CN/process/howto.rst:内核源码主目录中的:ref:`admin-guide/reporting-bugs.rst ` Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: 本文档将取代“Documentation/admin-guide/reporting-bugs.rst”。主要的工作 Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: “Documentation/admin-guide/reporting-bugs.rst”中的旧文字非常相似。它和它 Documentation/translations/it_IT/process/howto.rst:Il file admin-guide/reporting-bugs.rst nella cartella principale del kernel Documentation/translations/ja_JP/howto.rst:admin-guide/reporting-bugs.rstはカーネルバグらしいものについてどうレポー Ciao, Thorsten --- Documentation/admin-guide/index.rst | 1 - Documentation/admin-guide/reporting-bugs.rst | 187 -- .../admin-guide/reporting-issues.rst | 64 +- 3 files changed, 10 insertions(+), 242 deletions(-) delete mode 100644 Documentation/admin-guide/reporting-bugs.rst diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index 423116c4e787..dc00afcabb95 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -35,7 +35,6 @@ problems and bugs in particular. :maxdepth: 1 reporting-issues - Reporting bugs (obsolete) security-bugs bug-hunting bug-bisect diff --git a/Documentation/admin-guide/reporting-bugs.rst b/Documentation/admin-guide/reporting-bugs.rst deleted file mode 100644 index 409fa91d7495.. --- a/Documentation/admin-guide/reporting-bugs.rst +++ /dev/null @@ -1,187 +0,0 @@ -.. _reportingbugs: - -.. note:: - - This document is obsolete, and will be replaced by - 'Documentation/admin-guide/reporting-issues.rst' in the near future. - -Reporting bugs -++ - -Background -== - -The upstream Linux kernel maintainers only fix bugs for specific kernel -versions. Those versions include the current "release candidate" (or -rc) -kernel, any "stable" kernel versions, and any "long term" kernels. - -Please see https://www.kernel.org/ for a list of supported kernels. Any -kernel marked with [EOL] is "end of life" and will not have any fixes -backported to it. - -If you've found a bug on a kernel version that isn't listed on kernel.org, -contact your Linux distribution or embedded vendor for support. -Alternatively, you can attempt to run one of the supported stable or -rc -kernels, and see if you can reproduce the bug on that. It's preferable -to reproduce the bug on the latest -rc kernel. - - -How to report Linux kernel bugs -=== - - -Identify the problematic subsystem --- - -Identifying which part of the Linux kernel might be causing your issue -increases your chances of getting your bug fixed. Simply posting to the -generic linux-kernel mailing list (LKML) may cause your bug report to be -lost in the noise of a mailing list that gets 1000+ emails a day. - -Instead, try to figure out which kernel subsystem is causing the issue, -and email that subsystem's maintainer and mailing list. If the subsystem -maintainer doesn't answer, then expand your scope to mailing lists like -LKML. - - -Identify who to notify --- - -Once you know the subsystem that is causing the issue, you should send a -bug report. Some maintainers prefer bugs to be reported via bugzilla -(https://bugzilla.kernel.org), while others prefer that bugs be reported -via the subsystem mailing list. - -To find out where to send an emailed bug report, find your subsystem or -device driver in the MAINTAINERS file.
Re: [PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst
On Tue, Mar 30, 2021 at 04:13:04PM +0200, Thorsten Leemhuis wrote: > Removing Documentation/admin-guide/reporting-bugs.rst will break links > in some of the translations. I was unsure if simply changing them to > Documentation/admin-guide/reporting-issue.rst was wise, so I didn't > touch anything for now and CCed the maintainers for the Chinese and > Italian translation. I couldn't find one for the Japanse translation. > > Please advice. For completeness, this are the places where things will > break afaics: > > $ grep -ri 'reporting-bugs.rst' Documentation/ > Documentation/translations/zh_CN/SecurityBugs:是有帮助的信息，那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任 > Documentation/translations/zh_CN/process/howto.rst:内核源码主目录中的:ref:`admin-guide/reporting-bugs.rst > ` > Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: > 本文档将取代“Documentation/admin-guide/reporting-bugs.rst”。主要的工作 > Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: > “Documentation/admin-guide/reporting-bugs.rst”中的旧文字非常相似。它和它 > Documentation/translations/it_IT/process/howto.rst:Il file > admin-guide/reporting-bugs.rst nella cartella principale del kernel > Documentation/translations/ja_JP/howto.rst:admin-guide/reporting-bugs.rstはカーネルバグらしいものについてどうレポー Traditionally translations catch up much later on, you shouldn't have to worry about them the authors will clean them up and submit patches for them when they get the chance. thanks, greg k-h
Re: [PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst
On Tue, Mar 30, 2021 at 04:13:04PM +0200, Thorsten Leemhuis wrote: > Remove the WIP and two FIXME notes in the text to make it official, as > it's now considered fully ready for consumption. To make sure this > step is okay for people the intent of this change and the latest version > of the text were posted to ksummit-discuss; nobody complained, thus > lets move ahead. > > Add a footer to point out people can contact Thorsten directly in case > they find something to improve in the text. > > Dear reporting-bugs.rst, I'm sorry to tell you, but that makes you fully > obsolete and we thus have to let you go now. Thank you very much for > your service, you in one form or another have been around for a long > time. I'm sure over the years you got read a lot and helped quite a few > people. But it's time to retire now. Rest in peace. > > Signed-off-by: Thorsten Leemhuis > CC: Harry Wei > CC: Alex Shi > CC: Federico Vaga > CC: Greg KH Reviewed-by: Greg Kroah-Hartman
Re: [PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst
Cc Alex Shi's new email On Tue, Mar 30, 2021 at 04:13:04PM +0200, Thorsten Leemhuis wrote: > Removing Documentation/admin-guide/reporting-bugs.rst will break links > in some of the translations. I was unsure if simply changing them to > Documentation/admin-guide/reporting-issue.rst was wise, so I didn't > touch anything for now and CCed the maintainers for the Chinese and > Italian translation. I couldn't find one for the Japanse translation. > > Please advice. For completeness, this are the places where things will > break afaics: > > $ grep -ri 'reporting-bugs.rst' Documentation/ > Documentation/translations/zh_CN/SecurityBugs:是有帮助的信息，那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任 > Documentation/translations/zh_CN/process/howto.rst:内核源码主目录中的:ref:`admin-guide/reporting-bugs.rst > ` > Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: > 本文档将取代“Documentation/admin-guide/reporting-bugs.rst”。主要的工作 > Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: > “Documentation/admin-guide/reporting-bugs.rst”中的旧文字非常相似。它和它 Yeah, as Greg said, we will solve that after you patches be merged in next tree. Since I have translate the zh reporting-issues.rst in the next tree, will correct the link when I sync it with your new version. May cause Warning for some days, but don't worry about it. Wu X.C. > Documentation/translations/it_IT/process/howto.rst:Il file > admin-guide/reporting-bugs.rst nella cartella principale del kernel > Documentation/translations/ja_JP/howto.rst:admin-guide/reporting-bugs.rstはカーネルバグらしいものについてどうレポー > > Ciao, Thorsten
Re: [PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst
Greg KH writes: > On Tue, Mar 30, 2021 at 04:13:04PM +0200, Thorsten Leemhuis wrote: >> Removing Documentation/admin-guide/reporting-bugs.rst will break links >> in some of the translations. I was unsure if simply changing them to >> Documentation/admin-guide/reporting-issue.rst was wise, so I didn't >> touch anything for now and CCed the maintainers for the Chinese and >> Italian translation. I couldn't find one for the Japanse translation. > > Traditionally translations catch up much later on, you shouldn't have to > worry about them the authors will clean them up and submit patches for > them when they get the chance. Agreed. None of the broken references actually generate warnings (though perhaps some should) so we can let the translators catch up on their own time. I've applied the set and stuck in this tweak: > FWIW, this needs a > > s!stable/>_`!stable/>`_! > > Sorry, this slipped through. :-/ Ciao, Thorsten while I was at it. Thanks, jon
Re: [PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst
On 2021/3/31 下午4:33, Wu X.C. wrote: > Cc Alex Shi's new email > > On Tue, Mar 30, 2021 at 04:13:04PM +0200, Thorsten Leemhuis wrote: >> Removing Documentation/admin-guide/reporting-bugs.rst will break links >> in some of the translations. I was unsure if simply changing them to >> Documentation/admin-guide/reporting-issue.rst was wise, so I didn't A bit time info late won't hurt sth, people would update them soon if it's their care. >> touch anything for now and CCed the maintainers for the Chinese and >> Italian translation. I couldn't find one for the Japanse translation. >> >> Please advice. For completeness, this are the places where things will >> break afaics: >> >> $ grep -ri 'reporting-bugs.rst' Documentation/ >> Documentation/translations/zh_CN/SecurityBugs:是有帮助的信息，那就请重温一下admin-guide/reporting-bugs.rst文件中的概述过程。任 >> Documentation/translations/zh_CN/process/howto.rst:内核源码主目录中的:ref:`admin-guide/reporting-bugs.rst >> ` >> Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: >> 本文档将取代“Documentation/admin-guide/reporting-bugs.rst”。主要的工作 >> Documentation/translations/zh_CN/admin-guide/reporting-issues.rst: >> “Documentation/admin-guide/reporting-bugs.rst”中的旧文字非常相似。它和它 > > Yeah, as Greg said, we will solve that after you patches be merged in next > tree. Since I have translate the zh reporting-issues.rst in the next tree, > will correct the link when I sync it with your new version. May cause > Warning for some days, but don't worry about it. yes, also thanks for generous commitment! thanks Alex
Re: [PATCH v1 1/4] docs: make reporting-issues.rst official and delete reporting-bugs.rst
On 31.03.21 21:47, Jonathan Corbet wrote: > Greg KH writes: > >> On Tue, Mar 30, 2021 at 04:13:04PM +0200, Thorsten Leemhuis wrote: >>> Removing Documentation/admin-guide/reporting-bugs.rst will break links >>> in some of the translations. I was unsure if simply changing them to >>> Documentation/admin-guide/reporting-issue.rst was wise, so I didn't >>> touch anything for now and CCed the maintainers for the Chinese and >>> Italian translation. I couldn't find one for the Japanse translation. >> >> Traditionally translations catch up much later on, you shouldn't have to >> worry about them the authors will clean them up and submit patches for >> them when they get the chance. > > Agreed. None of the broken references actually generate warnings > (though perhaps some should) so we can let the translators catch up on > their own time. Ahh, good to know. BTW to the translators in the CC: sorry for not giving you a heads up earlier, things were supposed to get slower, but then had to be accelerated. > I've applied the set and stuck in this tweak: > >> FWIW, this needs a >> >> s!stable/>_`!stable/>`_! >> >> Sorry, this slipped through. :-/ Ciao, Thorsten > > while I was at it. Great, thx everyone, that what I had hoped for when I posted it. BTW, can't see the patches in docs-next yet, but I just assume it's just not pushed out yet for some reason. Whatever. Side note, FWIW: I have no further patches for the text in my queue, but I might sent one depending on how fast the new mailing list linux-regressions will be created (will as for that later today). Ciao, Thorsten
