[PATCH v4 0/3] docs: add two texts covering regressions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]


"We don't cause regressions" might be the first rule of Linux kernel
development, but it and other aspects of regressions nevertheless are hardly
described in the Linux kernel's documentation. The following patches change
this by creating two documents dedicated to the topic.

The second patch could easily be folded into the first one, but was kept
separate, as it might be a bit controversial. This also allows the patch
description to explain some backgrounds for this part of the document.
Additionally, ACKs and Reviewed-by tags can be collected separately this way.

v4 (this version):
- countless small and medium changes after review feedback from Jon (thx), which
  also lead to a big change:
- split the document into two, one for users and one for developers (both added
  by the first patch, as they are interlinked)
- fixed and improved a bunch of areas I stumbled upon while checking the text
  again after the split
- add a third patch to get one of the user-centric document on regressions
  mentioned in Documentation/admin-guide/reporting-issues.rst
- note: the content added by the second patch did not change significantly,
  that's why I left an earlier reviewed-by for the patch and an ACK for the
  series in place there, but dropped the ACK for the first patch of the series

v3 (https://lore.kernel.org/regressions/cover.1643110442.git.linux@xxxxxxxxxxxxx/):
- drop RFC tag
- heavily reshuffled and slightly adjusted the text in the sections "The
  important bits for people fixing regressions" and "How to add a regression to
  regzbot's tracking somebody else reported?" to make them easier to grasp
- a few small fixes and improvements
- add ACK for the series from Greg (now for real)

v2/RFC (https://lore.kernel.org/linux-doc/cover.1641565030.git.linux@xxxxxxxxxxxxx/):
- a lot of small fixes, most are for spelling mistakes and grammar
  errors/problems pointed out in the review feedback I got so far
- add ACK for the series from Greg

v1/RFC (https://lore.kernel.org/linux-doc/cover.1641203216.git.linux@xxxxxxxxxxxxx/):
- initial version


Hi! Here is a updated version of my patch-set adding documentation regarding
regression. This bring bigger changes after Jon took a look and suggested
splitting the text up. I did that and changed a bunch of other things along the
way. But I for now decided against splitting off the regression tracking stuff
into one or two other documents, as suggested by Jon, as that IMHO distributes
the information over too many places.

Ciao, Thorsten

Thorsten Leemhuis (3):
  docs: add two documents about regression handling
  docs: regressions*rst: rules of thumb for handling regressions
  docs: reporting-issues.rst: link new document about regressions

 Documentation/admin-guide/index.rst           |   1 +
 .../admin-guide/regressions-users.rst         | 448 +++++++++++
 .../admin-guide/reporting-issues.rst          |  60 +-
 Documentation/process/index.rst               |   1 +
 Documentation/process/regressions-devs.rst    | 753 ++++++++++++++++++
 MAINTAINERS                                   |   2 +
 6 files changed, 1234 insertions(+), 31 deletions(-)
 create mode 100644 Documentation/admin-guide/regressions-users.rst
 create mode 100644 Documentation/process/regressions-devs.rst

base-commit: b8f4eee6a630ef8c5f00594e25c377463b4f299c

[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux