Skip to contentSkip to conversation

packet.7: Update references to kernel documentation

PATCH In review Alejandro Colomar 2 participants 3 messages Dec 15, 2020 – Dec 20, 2020 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 packet.7: Update references to kernel documentation

From: Baruch Siach <[email protected]>

Files moved from .txt to .rst.

Also, drop / prefix from kernel source tree references.

---
 man7/packet.7 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
man7/packet.7 +4 -4
index ac1c60905..856c59e6b 100644
@@ -405,7 +405,7 @@ equal to
 .IP
 Packet sockets implement multiple variants of the packet ring.
 The implementation details are described in
-.IR Documentation/networking/packet_mmap.txt
+.IR Documentation/networking/packet_mmap.rst
 in the Linux kernel source tree.
 .TP
 .BR PACKET_STATISTICS
@@ -431,7 +431,7 @@ By default, this is a software generated timestamp generated when the
 packet is copied into the ring.
 This integer option selects the type of timestamp.
 Besides the default, it support the two hardware formats described in
-.IR Documentation/networking/timestamping.txt
+.IR Documentation/networking/timestamping.rst
 in the Linux kernel source tree.
 .TP
 .BR PACKET_TX_RING " (since Linux 2.6.31)"
@@ -648,9 +648,9 @@ The
 include file for physical-layer protocols.
 .PP
 The Linux kernel source tree.
-.IR /Documentation/networking/filter.txt
+.IR Documentation/networking/filter.rst
 describes how to apply Berkeley Packet Filters to packet sockets.
-.IR /tools/testing/selftests/net/psock_tpacket.c
+.IR tools/testing/selftests/net/psock_tpacket.c
 contains example source code for all available versions of
 .BR PACKET_RX_RING
 and

base-commit: 27482d700b5d2d062f994bee2c79aac7a5d9d17c

Signature · 1 line
2.29.2
#1 lore raw

Ping: [PATCH] packet.7: Update references to kernel documentation

Hi Michael,

I'm pinging you for pending patches before you release 5.10.

BTW, about this patch, my little brother, who is learning shell and linux is preparing a patch for fixing the paths for all other manual pages. :-)

Cheers,

Alex

Quoted 49 lines · Alejandro Colomar

From: Baruch Siach <[email protected]>

Files moved from .txt to .rst.

Also, drop / prefix from kernel source tree references.

---
 man7/packet.7 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
man7/packet.7 +4 -4
index ac1c60905..856c59e6b 100644
@@ -405,7 +405,7 @@ equal to
 .IP
 Packet sockets implement multiple variants of the packet ring.
 The implementation details are described in
-.IR Documentation/networking/packet_mmap.txt
+.IR Documentation/networking/packet_mmap.rst
 in the Linux kernel source tree.
 .TP
 .BR PACKET_STATISTICS
@@ -431,7 +431,7 @@ By default, this is a software generated timestamp generated when the
 packet is copied into the ring.
 This integer option selects the type of timestamp.
 Besides the default, it support the two hardware formats described in
-.IR Documentation/networking/timestamping.txt
+.IR Documentation/networking/timestamping.rst
 in the Linux kernel source tree.
 .TP
 .BR PACKET_TX_RING " (since Linux 2.6.31)"
@@ -648,9 +648,9 @@ The
 include file for physical-layer protocols.
 .PP
 The Linux kernel source tree.
-.IR /Documentation/networking/filter.txt
+.IR Documentation/networking/filter.rst
 describes how to apply Berkeley Packet Filters to packet sockets.
-.IR /tools/testing/selftests/net/psock_tpacket.c
+.IR tools/testing/selftests/net/psock_tpacket.c
 contains example source code for all available versions of
 .BR PACKET_RX_RING
 and

base-commit: 27482d700b5d2d062f994bee2c79aac7a5d9d17c

Signature · 3 lines
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
#2 lore raw
In reply to Alejandro Colomar

Hi Alex and Baruch,

Quoted 8 lines · Alejandro Colomar

From: Baruch Siach <[email protected]>

Files moved from .txt to .rst.

Also, drop / prefix from kernel source tree references.

Thanks. Patch applied.

Cheers,

Michael

Quoted 41 lines
---
 man7/packet.7 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
man7/packet.7 +4 -4
index ac1c60905..856c59e6b 100644
@@ -405,7 +405,7 @@ equal to
 .IP
 Packet sockets implement multiple variants of the packet ring.
 The implementation details are described in
-.IR Documentation/networking/packet_mmap.txt
+.IR Documentation/networking/packet_mmap.rst
 in the Linux kernel source tree.
 .TP
 .BR PACKET_STATISTICS
@@ -431,7 +431,7 @@ By default, this is a software generated timestamp generated when the
 packet is copied into the ring.
 This integer option selects the type of timestamp.
 Besides the default, it support the two hardware formats described in
-.IR Documentation/networking/timestamping.txt
+.IR Documentation/networking/timestamping.rst
 in the Linux kernel source tree.
 .TP
 .BR PACKET_TX_RING " (since Linux 2.6.31)"
@@ -648,9 +648,9 @@ The
 include file for physical-layer protocols.
 .PP
 The Linux kernel source tree.
-.IR /Documentation/networking/filter.txt
+.IR Documentation/networking/filter.rst
 describes how to apply Berkeley Packet Filters to packet sockets.
-.IR /tools/testing/selftests/net/psock_tpacket.c
+.IR tools/testing/selftests/net/psock_tpacket.c
 contains example source code for all available versions of
 .BR PACKET_RX_RING
 and

base-commit: 27482d700b5d2d062f994bee2c79aac7a5d9d17c

Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/