diff mbox series

[ovs-dev,5/5] Documentation: Update links to upstream Kernel documentation.

Message ID 20240227-doc-misc-v1-5-3d166cdd7e20@ovn.org
State Accepted
Commit cc0e7951818a48fbbd11664e1ad0a509a180b558
Delegated to: Simon Horman
Headers show
Series Documentation: Copyright, hyperlink and spelling corrections. | expand

Checks

Context Check Description
ovsrobot/apply-robot warning apply and check: warning
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/intel-ovs-compilation success test: success

Commit Message

Simon Horman Feb. 27, 2024, 3:36 p.m. UTC
This updates links to several upstream Kernel documents.

1. Lore is now the canonical archive for the netdev mailing list

2. net-next is now maintained by the netdev team,
   of which David Miller is currently a member,
   rather than only by David.

   Also, use HTTPS rather than HTTP.

3. The Netdev FAQ has evolved into the Netdev Maintainer Handbook.

4. The Kernel security document link was dead,
   provide the current canonical location for this document instead.

1., 2. & 3. Found by inspection
4. Flagged by check-docs

Signed-off-by: Simon Horman <horms@ovn.org>
---
 Documentation/internals/contributing/backporting-patches.rst | 10 +++++-----
 Documentation/internals/security.rst                         | 10 +++++-----
 2 files changed, 10 insertions(+), 10 deletions(-)

Comments

0-day Robot Feb. 27, 2024, 4:07 p.m. UTC | #1
Bleep bloop.  Greetings Simon Horman, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
WARNING: Line is 86 characters long (recommended limit is 79)
#60 FILE: Documentation/internals/contributing/backporting-patches.rst:116:
.. _Netdev Maintainer Handbook: https://docs.kernel.org/process/maintainer-netdev.html

WARNING: Line is 81 characters long (recommended limit is 79)
#61 FILE: Documentation/internals/contributing/backporting-patches.rst:117:
.. _net-next: https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git

Lines checked: 89, Warnings: 2, Errors: 0


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
Mike Pattrick Feb. 27, 2024, 6:02 p.m. UTC | #2
On Tue, Feb 27, 2024 at 10:37 AM Simon Horman <horms@ovn.org> wrote:
>
> This updates links to several upstream Kernel documents.
>
> 1. Lore is now the canonical archive for the netdev mailing list
>
> 2. net-next is now maintained by the netdev team,
>    of which David Miller is currently a member,
>    rather than only by David.
>
>    Also, use HTTPS rather than HTTP.
>
> 3. The Netdev FAQ has evolved into the Netdev Maintainer Handbook.
>
> 4. The Kernel security document link was dead,
>    provide the current canonical location for this document instead.
>
> 1., 2. & 3. Found by inspection
> 4. Flagged by check-docs
>
> Signed-off-by: Simon Horman <horms@ovn.org>

Acked-by: Mike Pattrick <mkp@redhat.com>
Eelco Chaudron Feb. 28, 2024, 9:43 a.m. UTC | #3
On 27 Feb 2024, at 16:36, Simon Horman wrote:

> This updates links to several upstream Kernel documents.
>
> 1. Lore is now the canonical archive for the netdev mailing list
>
> 2. net-next is now maintained by the netdev team,
>    of which David Miller is currently a member,
>    rather than only by David.
>
>    Also, use HTTPS rather than HTTP.
>
> 3. The Netdev FAQ has evolved into the Netdev Maintainer Handbook.
>
> 4. The Kernel security document link was dead,
>    provide the current canonical location for this document instead.
>
> 1., 2. & 3. Found by inspection
> 4. Flagged by check-docs
>
> Signed-off-by: Simon Horman <horms@ovn.org>

The changes look good to me.

Acked-by: Eelco Chaudron <echaudro@redhat.com>
diff mbox series

Patch

diff --git a/Documentation/internals/contributing/backporting-patches.rst b/Documentation/internals/contributing/backporting-patches.rst
index fae416eb3cd6..0ef7f5beb9b0 100644
--- a/Documentation/internals/contributing/backporting-patches.rst
+++ b/Documentation/internals/contributing/backporting-patches.rst
@@ -58,7 +58,7 @@  features which have been applied upstream, or bugfixes to the Open vSwitch
 datapath code. For bugfixes, the patches subsequently follow the regular Open
 vSwitch process as described above to reach older branches.
 
-__ http://vger.kernel.org/vger-lists.html#netdev
+__ https://lore.kernel.org/netdev/
 
 Changes to userspace components
 -------------------------------
@@ -93,8 +93,8 @@  Changes to Linux kernel components
 The Linux kernel components in Open vSwitch go through initial review in the
 upstream Linux netdev community before they go into the Open vSwitch tree. As
 such, backports from upstream to the Open vSwitch tree may include bugfixes or
-new features. The `netdev-FAQ`_ describes the general process for merging
-patches to the upstream Linux tree.
+new features. The `Netdev Maintainer Handbook`_ describes the general
+process for merging patches to the upstream Linux tree.
 
 To keep track of the changes which are made upstream against the changes which
 have been backported to the Open vSwitch tree, backports should be done in the
@@ -113,8 +113,8 @@  interests of keeping the Open vSwitch tree in sync with upstream `net-next`,
 contributors may send Open vSwitch kernel module changes independently of
 userspace changes.
 
-.. _netdev-faq: https://www.kernel.org/doc/Documentation/networking/netdev-FAQ.txt
-.. _net-next: http://git.kernel.org/cgit/linux/kernel/git/davem/net-next.git
+.. _Netdev Maintainer Handbook: https://docs.kernel.org/process/maintainer-netdev.html
+.. _net-next: https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git
 
 How to backport kernel patches
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/Documentation/internals/security.rst b/Documentation/internals/security.rst
index 444d07c3563e..e211c16a4316 100644
--- a/Documentation/internals/security.rst
+++ b/Documentation/internals/security.rst
@@ -90,11 +90,11 @@  Reporters may ask for a GPG key while initiating contact with the security team
 to deliver more sensitive reports.
 
 The Linux kernel has `its own vulnerability management process
-<https://static.lwn.net/kerneldoc/admin-guide/security-bugs.html>`__.  Handling
-of vulnerabilities that affect both the Open vSwitch tree and the upstream
-Linux kernel should be reported through both processes.  Send your report as a
-single email to both the kernel and OVS security teams to allow those teams to
-most easily coordinate among themselves.
+<https://docs.kernel.org/process/security-bugs.html?highlight=security>`__.
+Handling of vulnerabilities that affect both the Open vSwitch tree and the
+upstream Linux kernel should be reported through both processes.  Send your
+report as a single email to both the kernel and OVS security teams to allow
+those teams to most easily coordinate among themselves.
 
 Step 2: Assessment
 ------------------