lkml.org 
[lkml]   [2020]   [Nov]   [12]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[RFC PATCH v2 18/26] docs: reporting-bugs: let users optimize their notes
    Date
    The reader now users the mainline kernel and is getting closer to
    reporting the issue, so it's a good point to let people recheck and
    optimize their notes how to reproduce the issue. It's also a good moment
    to make them search again for existing reports, as they might have
    learned something in the previous steps.

    Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
    ---
    Documentation/admin-guide/reporting-bugs.rst | 19 +++++++++++++++++++
    1 file changed, 19 insertions(+)

    diff --git a/Documentation/admin-guide/reporting-bugs.rst b/Documentation/admin-guide/reporting-bugs.rst
    index 60a84f52724c..7af4e7a6e797 100644
    --- a/Documentation/admin-guide/reporting-bugs.rst
    +++ b/Documentation/admin-guide/reporting-bugs.rst
    @@ -820,6 +820,25 @@ head over to the section "Details about reporting issues only occurring in
    older kernel version lines" below.


    +Optimize description to reproduce issue
    +---------------------------------------
    +
    + *Optimize your notes: try to find and write the most straightforward way to
    + reproduce your issue. Make sure the end result has all the important
    + details, and at the same time is easy to read and understand for others
    + that hear about it for the first time. And if you learned something in this
    + process, consider searching again for existing reports about the issue.*
    +
    +An unnecessarily complex report will make it hard for others to understand your
    +report. Thus try to find a reproducer that's straight forward to describe and
    +thus easy to understand in written form. Include all important details, but at
    +the same time try to keep it as short as possible.
    +
    +In this in the previous steps you likely have learned a thing or two about the
    +issue you face. Use this knowledge and search again for existing reports
    +instead you can join.
    +
    +
    .. ############################################################################
    .. Temporary marker added while this document is rewritten. Sections above
    .. are new and dual-licensed under GPLv2+ and CC-BY 4.0, those below are old.
    --
    2.28.0
    \
     
     \ /
      Last update: 2020-11-12 19:01    [W:2.624 / U:0.064 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site