docs: update and move the netdev-FAQ
Subsystems (5)
Jakub Kicinski
maintainerv3 cover docs: update and move the netdev-FAQ
A section of documentation for tree-specific process quirks had been created a while back. There's only one tree in it, so far, the tip tree, but the contents seem to answer similar questions as we answer in the netdev-FAQ. Move the netdev-FAQ.
Take this opportunity to touch up and update a few sections.
v3: remove some confrontational? language from patch 7
v2: remove non-git in patch 3
add patch 5
Jakub Kicinski (14):
docs: netdev: replace references to old archives
docs: netdev: minor reword
docs: netdev: move the patch marking section up
docs: netdev: turn the net-next closed into a Warning
docs: netdev: note that RFC postings are allowed any time
docs: netdev: shorten the name and mention msgid for patch status
docs: netdev: rephrase the 'Under review' question
docs: netdev: rephrase the 'should I update patchwork' question
docs: netdev: add a question about re-posting frequency
docs: netdev: make the testing requirement more stringent
docs: netdev: add missing back ticks
docs: netdev: call out the merge window in tag checking
docs: netdev: broaden the new vs old code formatting guidelines
docs: netdev: move the netdev-FAQ to the process pages
Documentation/bpf/bpf_devel_QA.rst | 2 +-
Documentation/networking/index.rst | 3 +-
.../process/maintainer-handbooks.rst | 1 +
.../maintainer-netdev.rst} | 114 +++++++++++-------
MAINTAINERS | 1 +
5 files changed, 73 insertions(+), 48 deletions(-)
rename Documentation/{networking/netdev-FAQ.rst => process/maintainer-netdev.rst} (75%)Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 1/14 docs: netdev: replace references to old archives
Most people use (or should use) lore at this point. Replace the pointers to older archiving systems.
--- Documentation/networking/netdev-FAQ.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-)
Documentation/networking/netdev-FAQ.rst +2 -4
@@ -16,10 +16,8 @@ Note that some subsystems (e.g. wireless drivers) which have a high volume of traffic have their own specific mailing lists. The netdev list is managed (like many other Linux mailing lists) through -VGER (http://vger.kernel.org/) and archives can be found below: - -- http://marc.info/?l=linux-netdev -- http://www.spinics.net/lists/netdev/ +VGER (http://vger.kernel.org/) with archives available at +https://lore.kernel.org/netdev/ Aside from subsystems like that mentioned above, all network-related Linux development (i.e. RFC, review, comments, etc.) takes place on
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 2/14 docs: netdev: minor reword
In reply to Jakub Kicinskithat -> those
--- Documentation/networking/netdev-FAQ.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/networking/netdev-FAQ.rst +1 -1
@@ -19,7 +19,7 @@ The netdev list is managed (like many other Linux mailing lists) through VGER (http://vger.kernel.org/) with archives available at https://lore.kernel.org/netdev/ -Aside from subsystems like that mentioned above, all network-related +Aside from subsystems like those mentioned above, all network-related Linux development (i.e. RFC, review, comments, etc.) takes place on netdev.
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 3/14 docs: netdev: move the patch marking section up
In reply to Jakub KicinskiWe want people to mark their patches with net and net-next in the subject. Many miss doing that. Move the FAQ section which points that out up, and place it after the section which enumerates the trees, that seems like a pretty logical place for it. Since the two sections are together we can remove a little bit (not too much) of the repetition.
v2: also remove the text for non-git setups, we want people to use git.
--- Documentation/networking/netdev-FAQ.rst | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-)
Documentation/networking/netdev-FAQ.rst +11 -14
@@ -35,6 +35,17 @@ mainline tree from Linus, and ``net-next`` is where the new code goes - https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net.git - https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git +How do I indicate which tree (net vs. net-next) my patch should be in? +---------------------------------------------------------------------- +To help maintainers and CI bots you should explicitly mark which tree +your patch is targeting. Assuming that you use git, use the prefix +flag:: + + git format-patch --subject-prefix='PATCH net-next' start..finish + +Use ``net`` instead of ``net-next`` (always lower case) in the above for +bug-fix ``net`` content. + How often do changes from these trees make it to the mainline Linus tree? ------------------------------------------------------------------------- To understand this, you need to know a bit of background information on
@@ -90,20 +101,6 @@ and note the top of the "tags" section. If it is rc1, it is early in the dev cycle. If it was tagged rc7 a week ago, then a release is probably imminent. -How do I indicate which tree (net vs. net-next) my patch should be in? ----------------------------------------------------------------------- -Firstly, think whether you have a bug fix or new "next-like" content. -Then once decided, assuming that you use git, use the prefix flag, i.e. -:: - - git format-patch --subject-prefix='PATCH net-next' start..finish - -Use ``net`` instead of ``net-next`` (always lower case) in the above for -bug-fix ``net`` content. If you don't use git, then note the only magic -in the above is just the subject text of the outgoing e-mail, and you -can manually change it yourself with whatever MUA you are comfortable -with. - I sent a patch and I'm wondering what happened to it - how can I tell whether it got merged? -------------------------------------------------------------------------------------------- Start by looking at the main patchworks queue for netdev:
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 4/14 docs: netdev: turn the net-next closed into a Warning
In reply to Jakub KicinskiUse the sphinx Warning box to make the net-next being closed stand out more.
--- Documentation/networking/netdev-FAQ.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/networking/netdev-FAQ.rst +3 -2
@@ -70,8 +70,9 @@ relating to vX.Y An announcement indicating when ``net-next`` has been closed is usually sent to netdev, but knowing the above, you can predict that in advance. -IMPORTANT: Do not send new ``net-next`` content to netdev during the -period during which ``net-next`` tree is closed. +.. warning:: + Do not send new ``net-next`` content to netdev during the + period during which ``net-next`` tree is closed. Shortly after the two weeks have passed (and vX.Y-rc1 is released), the tree for ``net-next`` reopens to collect content for the next (vX.Y+1)
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 5/14 docs: netdev: note that RFC postings are allowed any time
In reply to Jakub KicinskiDocument that RFCs are allowed during the merge window.
---
v2: new patch
--- Documentation/networking/netdev-FAQ.rst | 3 +++ 1 file changed, 3 insertions(+)
Documentation/networking/netdev-FAQ.rst +3 -0
@@ -74,6 +74,9 @@ sent to netdev, but knowing the above, you can predict that in advance. Do not send new ``net-next`` content to netdev during the period during which ``net-next`` tree is closed. +RFC patches sent for review only are obviously welcome at any time +(use ``--subject-prefix='RFC net-next'`` with ``git format-patch``). + Shortly after the two weeks have passed (and vX.Y-rc1 is released), the tree for ``net-next`` reopens to collect content for the next (vX.Y+1) release.
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 6/14 docs: netdev: shorten the name and mention msgid for patch status
In reply to Jakub KicinskiCut down the length of the question so it renders better in docs. Mention that Message-ID can be used to search patchwork.
--- Documentation/networking/netdev-FAQ.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
Documentation/networking/netdev-FAQ.rst +5 -3
@@ -105,14 +105,16 @@ and note the top of the "tags" section. If it is rc1, it is early in the dev cycle. If it was tagged rc7 a week ago, then a release is probably imminent. -I sent a patch and I'm wondering what happened to it - how can I tell whether it got merged? --------------------------------------------------------------------------------------------- +How can I tell the status of a patch I've sent? +----------------------------------------------- Start by looking at the main patchworks queue for netdev: https://patchwork.kernel.org/project/netdevbpf/list/ The "State" field will tell you exactly where things are at with your -patch. +patch. Patches are indexed by the ``Message-ID`` header of the emails +which carried them so if you have trouble finding your patch append +the value of ``Message-ID`` to the URL above. The above only says "Under Review". How can I find out more? -------------------------------------------------------------
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 7/14 docs: netdev: rephrase the 'Under review' question
In reply to Jakub KicinskiThe semantics of "Under review" have shifted. Reword the question about it a bit and focus it on the response time.
---
v3: remove the going back to the end of the queue threat
--- Documentation/networking/netdev-FAQ.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
Documentation/networking/netdev-FAQ.rst +5 -3
@@ -116,10 +116,12 @@ patch. Patches are indexed by the ``Message-ID`` header of the emails which carried them so if you have trouble finding your patch append the value of ``Message-ID`` to the URL above. -The above only says "Under Review". How can I find out more? -------------------------------------------------------------- +How long before my patch is accepted? +------------------------------------- Generally speaking, the patches get triaged quickly (in less than -48h). So be patient. Asking the maintainer for status updates on your +48h). But be patient, if your patch is active in patchwork (i.e. it's +listed on the project's patch list) the chances it was missed are close to zero. +Asking the maintainer for status updates on your patch is a good way to ensure your patch is ignored or pushed to the bottom of the priority list.
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 8/14 docs: netdev: rephrase the 'should I update patchwork' question
In reply to Jakub KicinskiMake the question shorter and adjust the start of the answer accordingly.
--- Documentation/networking/netdev-FAQ.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
Documentation/networking/netdev-FAQ.rst +5 -3
@@ -125,9 +125,11 @@ Asking the maintainer for status updates on your patch is a good way to ensure your patch is ignored or pushed to the bottom of the priority list. -I submitted multiple versions of the patch series. Should I directly update patchwork for the previous versions of these patch series? --------------------------------------------------------------------------------------------------------------------------------------- -No, please don't interfere with the patch status on patchwork, leave +Should I directly update patchwork state of my own patches? +----------------------------------------------------------- +It may be tempting to help the maintainers and update the state of your +own patches when you post a new version or spot a bug. Please do not do that. +Interfering with the patch status on patchwork will only cause confusion. Leave it to the maintainer to figure out what is the most recent and current version that should be applied. If there is any doubt, the maintainer will reply and ask what should be done.
Signature · 1 line
2.34.1
Re: [PATCH net v3 08/14] docs: netdev: rephrase the 'should I update patchwork' question
Quoted 3 lines · Jakub Kicinski
Make the question shorter and adjust the start of the answer accordingly.
Signed-off-by Jakub Kicinski <[email protected]>
Signature · 1 line
Florian
Jakub Kicinski
maintainerPATCH v3 9/14 docs: netdev: add a question about re-posting frequency
In reply to Jakub KicinskiWe have to tell people to stop reposting to often lately, or not to repost while the discussion is ongoing. Document this.
--- Documentation/networking/netdev-FAQ.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)
Documentation/networking/netdev-FAQ.rst +11 -0
@@ -140,6 +140,17 @@ No, please resend the entire patch series and make sure you do number your patches such that it is clear this is the latest and greatest set of patches that can be applied. +I have received review feedback, when should I post a revised version of the patches? +------------------------------------------------------------------------------------- +Allow at least 24 hours to pass between postings. This will ensure reviewers +from all geographical locations have a chance to chime in. Do not wait +too long (weeks) between postings either as it will make it harder for reviewers +to recall all the context. + +Make sure you address all the feedback in your new posting. Do not post a new +version of the code if the discussion about the previous version is still +ongoing, unless directly instructed by a reviewer. + I submitted multiple versions of a patch series and it looks like a version other than the last one has been accepted, what should I do? ---------------------------------------------------------------------------------------------------------------------------------------- There is no revert possible, once it is pushed out, it stays like that.
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 10/14 docs: netdev: make the testing requirement more stringent
In reply to Jakub KicinskiThese days we often ask for selftests so let's update our testing requirements.
--- Documentation/networking/netdev-FAQ.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-)
Documentation/networking/netdev-FAQ.rst +9 -5
@@ -196,11 +196,15 @@ as possible alternative mechanisms. What level of testing is expected before I submit my change? ------------------------------------------------------------ -If your changes are against ``net-next``, the expectation is that you -have tested by layering your changes on top of ``net-next``. Ideally -you will have done run-time testing specific to your change, but at a -minimum, your changes should survive an ``allyesconfig`` and an -``allmodconfig`` build without new warnings or failures. +At the very minimum your changes must survive an ``allyesconfig`` and an +``allmodconfig`` build with ``W=1`` set without new warnings or failures. + +Ideally you will have done run-time testing specific to your change, +and the patch series contains a set of kernel selftest for +``tools/testing/selftests/net`` or using the KUnit framework. + +You are expected to test your changes on top of the relevant networking +tree (``net`` or ``net-next``) and not e.g. a stable tree or ``linux-next``. How do I post corresponding changes to user space components? -------------------------------------------------------------
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 11/14 docs: netdev: add missing back ticks
In reply to Jakub KicinskiI think double back ticks are more correct. Add where they are missing.
--- Documentation/networking/netdev-FAQ.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
Documentation/networking/netdev-FAQ.rst +6 -6
@@ -218,7 +218,7 @@ or the user space project is not reviewed on netdev include a link to a public repo where user space patches can be seen. In case user space tooling lives in a separate repository but is -reviewed on netdev (e.g. patches to `iproute2` tools) kernel and +reviewed on netdev (e.g. patches to ``iproute2`` tools) kernel and user space patches should form separate series (threads) when posted to the mailing list, e.g.::
@@ -251,18 +251,18 @@ traffic if we can help it. netdevsim is great, can I extend it for my out-of-tree tests? ------------------------------------------------------------- -No, `netdevsim` is a test vehicle solely for upstream tests. -(Please add your tests under tools/testing/selftests/.) +No, ``netdevsim`` is a test vehicle solely for upstream tests. +(Please add your tests under ``tools/testing/selftests/``.) -We also give no guarantees that `netdevsim` won't change in the future +We also give no guarantees that ``netdevsim`` won't change in the future in a way which would break what would normally be considered uAPI. Is netdevsim considered a "user" of an API? ------------------------------------------- Linux kernel has a long standing rule that no API should be added unless -it has a real, in-tree user. Mock-ups and tests based on `netdevsim` are -strongly encouraged when adding new APIs, but `netdevsim` in itself +it has a real, in-tree user. Mock-ups and tests based on ``netdevsim`` are +strongly encouraged when adding new APIs, but ``netdevsim`` in itself is **not** considered a use case/user. Any other tips to help ensure my net/net-next patch gets OK'd?
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 12/14 docs: netdev: call out the merge window in tag checking
In reply to Jakub KicinskiAdd the most important case to the question about "where are we in the cycle" - the case of net-next being closed.
--- Documentation/networking/netdev-FAQ.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/networking/netdev-FAQ.rst +3 -1
@@ -103,7 +103,9 @@ So where are we now in this cycle? and note the top of the "tags" section. If it is rc1, it is early in the dev cycle. If it was tagged rc7 a week ago, then a release is -probably imminent. +probably imminent. If the most recent tag is a final release tag +(without an ``-rcN`` suffix) - we are most likely in a merge window +and ``net-next`` is closed. How can I tell the status of a patch I've sent? -----------------------------------------------
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 13/14 docs: netdev: broaden the new vs old code formatting guidelines
In reply to Jakub KicinskiConvert the "should I use new or old comment formatting" to cover all formatting. This makes the question itself shorter.
--- Documentation/networking/netdev-FAQ.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/networking/netdev-FAQ.rst +4 -4
@@ -183,10 +183,10 @@ Is the comment style convention different for the networking content? * another line of text */ -I am working in existing code that has the former comment style and not the latter. Should I submit new code in the former style or the latter? ------------------------------------------------------------------------------------------------------------------------------------------------ -Make it the latter style, so that eventually all code in the domain -of netdev is of this format. +I am working in existing code which uses non-standard formatting. Which formatting should I use? +------------------------------------------------------------------------------------------------ +Make your code follow the most recent guidelines, so that eventually all code +in the domain of netdev is in the preferred format. I found a bug that might have possible security implications or similar. Should I mail the main netdev maintainer off-list? ---------------------------------------------------------------------------------------------------------------------------
Signature · 1 line
2.34.1
Jakub Kicinski
maintainerPATCH v3 14/14 docs: netdev: move the netdev-FAQ to the process pages
In reply to Jakub KicinskiThe documentation for the tip tree is really in quite a similar spirit to the netdev-FAQ. Move the netdev-FAQ to the process docs as well.
---
Documentation/bpf/bpf_devel_QA.rst | 2 +-
Documentation/networking/index.rst | 3 ++-
Documentation/process/maintainer-handbooks.rst | 1 +
.../netdev-FAQ.rst => process/maintainer-netdev.rst} | 0
MAINTAINERS | 1 +
5 files changed, 5 insertions(+), 2 deletions(-)
rename Documentation/{networking/netdev-FAQ.rst => process/maintainer-netdev.rst} (100%)Documentation/bpf/bpf_devel_QA.rst +1 -1
@@ -658,7 +658,7 @@ Otherwise, you can use ``bpf`` target. Additionally, you *must* use bpf target .. Links .. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/ -.. _netdev-FAQ: ../networking/netdev-FAQ.rst +.. _netdev-FAQ: Documentation/process/maintainer-netdev.rst .. _selftests: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/ .. _Documentation/dev-tools/kselftest.rst:
Documentation/networking/index.rst +2 -1
@@ -1,12 +1,13 @@ Linux Networking Documentation ============================== +Refer to :ref:`netdev-FAQ` for a guide on netdev development process specifics. + Contents: .. toctree:: :maxdepth: 2 - netdev-FAQ af_xdp bareudp batman-adv
Documentation/process/maintainer-handbooks.rst +1 -0
@@ -16,3 +16,4 @@ which is supplementary to the general development process handbook :maxdepth: 2 maintainer-tip + maintainer-netdev
Documentation/process/maintainer-netdev.rst renamed from Documentation/networking/netdev-FAQ.rst +0 -0
MAINTAINERS +1 -0
@@ -13661,6 +13661,7 @@ B: mailto:[email protected] T: git git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git F: Documentation/networking/ +F: Documentation/process/maintainer-netdev.rst F: include/linux/in.h F: include/linux/net.h F: include/linux/netdevice.h
Signature · 1 line
2.34.1
This series was applied to netdev/net.git (master) by Paolo Abeni <[email protected]>:
Hello:
This series was applied to netdev/net.git (master) by Paolo Abeni <[email protected]>:
Quoted 8 lines · On Tue, 29 Mar 2022 21:24:51 -0700 you wrote:
A section of documentation for tree-specific process quirks had been created a while back. There's only one tree in it, so far, the tip tree, but the contents seem to answer similar questions as we answer in the netdev-FAQ. Move the netdev-FAQ.
Take this opportunity to touch up and update a few sections.
[...]
Here is the summary with links:
- [net,v3,01/14] docs: netdev: replace references to old archives
https://git.kernel.org/netdev/net/c/50386f7526dd - [net,v3,02/14] docs: netdev: minor reword https://git.kernel.org/netdev/net/c/30cddd30532a - [net,v3,03/14] docs: netdev: move the patch marking section up https://git.kernel.org/netdev/net/c/c82d90b14f6c - [net,v3,04/14] docs: netdev: turn the net-next closed into a Warning https://git.kernel.org/netdev/net/c/2fd4c50dbff1 - [net,v3,05/14] docs: netdev: note that RFC postings are allowed any time https://git.kernel.org/netdev/net/c/0e242e3fb7a7 - [net,v3,06/14] docs: netdev: shorten the name and mention msgid for patch status https://git.kernel.org/netdev/net/c/5d84921ac750 - [net,v3,07/14] docs: netdev: rephrase the 'Under review' question https://git.kernel.org/netdev/net/c/8f785c1bb84f - [net,v3,08/14] docs: netdev: rephrase the 'should I update patchwork' question https://git.kernel.org/netdev/net/c/724c1a7443c5 - [net,v3,09/14] docs: netdev: add a question about re-posting frequency https://git.kernel.org/netdev/net/c/b8ba106378a0 - [net,v3,10/14] docs: netdev: make the testing requirement more stringent https://git.kernel.org/netdev/net/c/3eca381457ca - [net,v3,11/14] docs: netdev: add missing back ticks https://git.kernel.org/netdev/net/c/a30059731877 - [net,v3,12/14] docs: netdev: call out the merge window in tag checking https://git.kernel.org/netdev/net/c/99eba4e5cbd4 - [net,v3,13/14] docs: netdev: broaden the new vs old code formatting guidelines https://git.kernel.org/netdev/net/c/08767a26f095 - [net,v3,14/14] docs: netdev: move the netdev-FAQ to the process pages https://git.kernel.org/netdev/net/c/8df0136376dc
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html