[PATCH net 00/13] docs: update and move the netdev-FAQ

[PATCH net 00/13] docs: update and move the netdev-FAQ

[Jakub Kicinski]

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.

Jakub Kicinski (13):
  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: 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} (76%)

-- 
2.34.1

[PATCH net 01/13] docs: netdev: replace references to old archives

[Jakub Kicinski]

Most people use (or should use) lore at this point.
Replace the pointers to older archiving systems.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index e26532f49760..25b8a7de737c 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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
-- 
2.34.1

[PATCH net 02/13] docs: netdev: minor reword

[Jakub Kicinski]

that -> those

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 25b8a7de737c..f7e5755e013e 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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.
 
-- 
2.34.1

[PATCH net 03/13] docs: netdev: move the patch marking section up

[Jakub Kicinski]

We 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.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 28 ++++++++++++-------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index f7e5755e013e..0bff899f286f 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -35,6 +35,20 @@ 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.  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.
+
 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 +104,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:
-- 
2.34.1

Re: [PATCH net 03/13] docs: netdev: move the patch marking section up

[Andrew Lunn]

> +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.  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.

Maybe we should consider removing the 'If you don't use git...' text.

We want people to use git.

Anybody who can correctly format a patch and get it passed their MTU
and mail system without it getting corrupted not using git should be
able to figure out how to set the subject line correctly.

	Andrew

Re: [PATCH net 03/13] docs: netdev: move the patch marking section up

[Jakub Kicinski]

On Sun, 27 Mar 2022 18:28:35 +0200 Andrew Lunn wrote:
> > +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.  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.  
> 
> Maybe we should consider removing the 'If you don't use git...' text.
> 
> We want people to use git.
> 
> Anybody who can correctly format a patch and get it passed their MTU
> and mail system without it getting corrupted not using git should be
> able to figure out how to set the subject line correctly.

Sounds good to me.

[PATCH net 04/13] docs: netdev: turn the net-next closed into a Warning

[Jakub Kicinski]

Use the sphinx Warning box to make the net-next being closed
stand out more.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 0bff899f286f..c1683ed1faca 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -73,8 +73,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)
-- 
2.34.1

Re: [PATCH net 04/13] docs: netdev: turn the net-next closed into a Warning

[Andrew Lunn]

On Sat, Mar 26, 2022 at 07:53:51PM -0700, Jakub Kicinski wrote:
> Use the sphinx Warning box to make the net-next being closed
> stand out more.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
>  Documentation/networking/netdev-FAQ.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
> index 0bff899f286f..c1683ed1faca 100644
> --- a/Documentation/networking/netdev-FAQ.rst
> +++ b/Documentation/networking/netdev-FAQ.rst
> @@ -73,8 +73,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)

Maybe somewhere around here mention that RFC patches can be posted
while net-next is closed? It is something we keep telling people, so
probably should be a FAQ item.

      Andrew

Re: [PATCH net 04/13] docs: netdev: turn the net-next closed into a Warning

[Martin Habets]

On Sat, Mar 26, 2022 at 07:53:51PM -0700, Jakub Kicinski wrote:
> Use the sphinx Warning box to make the net-next being closed
> stand out more.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
>  Documentation/networking/netdev-FAQ.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
> index 0bff899f286f..c1683ed1faca 100644
> --- a/Documentation/networking/netdev-FAQ.rst
> +++ b/Documentation/networking/netdev-FAQ.rst
> @@ -73,8 +73,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.

Similar to the comment from Kuniyuki I was missing a reference to
 http://vger.kernel.org/~davem/net-next.html
here.

Martin

>  
>  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)
> -- 
> 2.34.1

[PATCH net 05/13] docs: netdev: shorten the name and mention msgid for patch status

[Jakub Kicinski]

Cut down the length of the question so it renders better in docs.
Mention that Message-ID can be used to search patchwork.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index c1683ed1faca..f0d452846d84 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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?
 -------------------------------------------------------------
-- 
2.34.1

[PATCH net 06/13] docs: netdev: rephrase the 'Under review' question

[Jakub Kicinski]

The semantics of "Under review" have shifted. Reword the question
about it a bit and focus it on the response time.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index f0d452846d84..5f7b1e6fb249 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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.
 
-- 
2.34.1

[PATCH net 07/13] docs: netdev: rephrase the 'should I update patchwork' question

[Jakub Kicinski]

Make the question shorter and adjust the start of the answer accordingly.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 5f7b1e6fb249..d2ad55db7d8a 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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.
-- 
2.34.1

[PATCH net 08/13] docs: netdev: add a question about re-posting frequency

[Jakub Kicinski]

We have to tell people to stop reposting to often lately,
or not to repost while the discussion is ongoing.
Document this.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index d2ad55db7d8a..85a0af5dca65 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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.
-- 
2.34.1

Re: [PATCH net 08/13] docs: netdev: add a question about re-posting frequency

[Andrew Lunn]

On Sat, Mar 26, 2022 at 07:53:55PM -0700, Jakub Kicinski wrote:
> We have to tell people to stop reposting to often lately,
> or not to repost while the discussion is ongoing.
> Document this.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>

Reviewed-by: Andrew Lunn <andrew@lunn.ch>

    Andrew

[PATCH net 09/13] docs: netdev: make the testing requirement more stringent

[Jakub Kicinski]

These days we often ask for selftests so let's update our
testing requirements.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 85a0af5dca65..26110201f301 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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?
 -------------------------------------------------------------
-- 
2.34.1

Re: [PATCH net 09/13] docs: netdev: make the testing requirement more stringent

[Andrew Lunn]

On Sat, Mar 26, 2022 at 07:53:56PM -0700, Jakub Kicinski wrote:
> These days we often ask for selftests so let's update our
> testing requirements.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
>  Documentation/networking/netdev-FAQ.rst | 14 +++++++++-----
>  1 file changed, 9 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
> index 85a0af5dca65..26110201f301 100644
> --- a/Documentation/networking/netdev-FAQ.rst
> +++ b/Documentation/networking/netdev-FAQ.rst
> @@ -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.

Doesn't the patchwork buildbot also have C=1 ? You have been pointing
out failures for C=1, so it probably should be documented here.

	 Andrew

Re: [PATCH net 09/13] docs: netdev: make the testing requirement more stringent

[Jakub Kicinski]

On Sun, 27 Mar 2022 18:42:59 +0200 Andrew Lunn wrote:
> >  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.  
> 
> Doesn't the patchwork buildbot also have C=1 ? You have been pointing
> out failures for C=1, so it probably should be documented here.

We have a number of cases where C=1 failures are false positives. 
Sparse is not getting much love these days, unfortunately.
I didn't want to force people to bend over backwards to fix stuff
we can let fly upstream. I can't think of a case where W=1 was okay.

[PATCH net 10/13] docs: netdev: add missing back ticks

[Jakub Kicinski]

I think double back ticks are more correct. Add where they are missing.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 26110201f301..17c0f8a73a4b 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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?
-- 
2.34.1

[PATCH net 11/13] docs: netdev: call out the merge window in tag checking

[Jakub Kicinski]

Add the most important case to the question about "where are we
in the cycle" - the case of net-next being closed.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index 17c0f8a73a4b..a7367a757a4b 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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?
 -----------------------------------------------
-- 
2.34.1

[PATCH net 12/13] docs: netdev: broaden the new vs old code formatting guidelines

[Jakub Kicinski]

Convert the "should I use new or old comment formatting" to cover
all formatting. This makes the question itself shorter.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdev-FAQ.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/networking/netdev-FAQ.rst
index a7367a757a4b..47ea5d052c0b 100644
--- a/Documentation/networking/netdev-FAQ.rst
+++ b/Documentation/networking/netdev-FAQ.rst
@@ -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?
 ---------------------------------------------------------------------------------------------------------------------------
-- 
2.34.1

[PATCH net 13/13] docs: netdev: move the netdev-FAQ to the process pages

[Jakub Kicinski]

The 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.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 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%)

diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index 253496af8fef..761474bd7fe6 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -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:
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index ce017136ab05..72cf33579b78 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -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
diff --git a/Documentation/process/maintainer-handbooks.rst b/Documentation/process/maintainer-handbooks.rst
index 6af1abb0da48..d783060b4cc6 100644
--- a/Documentation/process/maintainer-handbooks.rst
+++ b/Documentation/process/maintainer-handbooks.rst
@@ -16,3 +16,4 @@ which is supplementary to the general development process handbook
    :maxdepth: 2
 
    maintainer-tip
+   maintainer-netdev
diff --git a/Documentation/networking/netdev-FAQ.rst b/Documentation/process/maintainer-netdev.rst
similarity index 100%
rename from Documentation/networking/netdev-FAQ.rst
rename to Documentation/process/maintainer-netdev.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 91c04cb65247..fc1ee838d103 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -13499,6 +13499,7 @@ B:	mailto:netdev@vger.kernel.org
 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
-- 
2.34.1

Re: [PATCH net 00/13] docs: update and move the netdev-FAQ

[Kuniyuki Iwashima]

From:   Jakub Kicinski <kuba@kernel.org>
Date:   Sat, 26 Mar 2022 19:53:47 -0700
> 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.

Thanks for update!

I would like to clarify one thing about this website.

  http://vger.kernel.org/~davem/net-next.html

I often check this before submitting patches.  I like this much, but it
seems not working properly for now.  Is this no longer maintained or by
coincidence this time?  If I could help something, please let me know :)

Re: [PATCH net 00/13] docs: update and move the netdev-FAQ

[Jakub Kicinski]

On Tue, 29 Mar 2022 13:38:08 +0900 Kuniyuki Iwashima wrote:
> From:   Jakub Kicinski <kuba@kernel.org>
> Date:   Sat, 26 Mar 2022 19:53:47 -0700
> > 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.  
> 
> Thanks for update!
> 
> I would like to clarify one thing about this website.
> 
>   http://vger.kernel.org/~davem/net-next.html
> 
> I often check this before submitting patches.  I like this much, but it
> seems not working properly for now.  Is this no longer maintained or by
> coincidence this time?  If I could help something, please let me know :)

Sorry about that, DaveM has been traveling during this merge window. 
He said he'll fix it soon.

Re: [PATCH net 00/13] docs: update and move the netdev-FAQ

[Kuniyuki Iwashima]

From:   Jakub Kicinski <kuba@kernel.org>
Date:   Mon, 28 Mar 2022 21:52:47 -0700
> On Tue, 29 Mar 2022 13:38:08 +0900 Kuniyuki Iwashima wrote:
> > From:   Jakub Kicinski <kuba@kernel.org>
> > Date:   Sat, 26 Mar 2022 19:53:47 -0700
> > > 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.  
> > 
> > Thanks for update!
> > 
> > I would like to clarify one thing about this website.
> > 
> >   http://vger.kernel.org/~davem/net-next.html
> > 
> > I often check this before submitting patches.  I like this much, but it
> > seems not working properly for now.  Is this no longer maintained or by
> > coincidence this time?  If I could help something, please let me know :)
> 
> Sorry about that, DaveM has been traveling during this merge window. 
> He said he'll fix it soon.

Ah, sorry for noise, and thank you!

Have a nice trip, DaveM!