Skip to content

Commit e110ba6

Browse files
committed
docs: netdev: add note about Changes Requested and revising commit messages
One of the most commonly asked questions is "I answered all questions and don't need to make any code changes, why was the patch not applied". Document our time honored tradition of asking people to repost with improved commit messages, to record the answers to reviewer questions. Take this opportunity to also recommend a change log format. Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jakub Kicinski <[email protected]>
1 parent 4691720 commit e110ba6

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

Documentation/process/maintainer-netdev.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ Finally, the vX.Y gets released, and the whole cycle starts over.
109109
netdev patch review
110110
-------------------
111111

112+
.. _patch_status:
113+
112114
Patch status
113115
~~~~~~~~~~~~
114116

@@ -143,6 +145,33 @@ Asking the maintainer for status updates on your
143145
patch is a good way to ensure your patch is ignored or pushed to the
144146
bottom of the priority list.
145147

148+
Changes requested
149+
~~~~~~~~~~~~~~~~~
150+
151+
Patches :ref:`marked<patch_status>` as ``Changes Requested`` need
152+
to be revised. The new version should come with a change log,
153+
preferably including links to previous postings, for example::
154+
155+
[PATCH net-next v3] net: make cows go moo
156+
157+
Even users who don't drink milk appreciate hearing the cows go "moo".
158+
159+
The amount of mooing will depend on packet rate so should match
160+
the diurnal cycle quite well.
161+
162+
Signed-of-by: Joe Defarmer <[email protected]>
163+
---
164+
v3:
165+
- add a note about time-of-day mooing fluctuation to the commit message
166+
v2: https://lore.kernel.org/netdev/[email protected]/
167+
- fix missing argument in kernel doc for netif_is_bovine()
168+
- fix memory leak in netdev_register_cow()
169+
v1: https://lore.kernel.org/netdev/[email protected]/
170+
171+
The commit message should be revised to answer any questions reviewers
172+
had to ask in previous discussions. Occasionally the update of
173+
the commit message will be the only change in the new version.
174+
146175
Partial resends
147176
~~~~~~~~~~~~~~~
148177

0 commit comments

Comments
 (0)