Skip to contentSkip to conversation

man7: unify socket examples

PATCH In review Jeremy Kerr 2 participants 3 messages Nov 11, 2021 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 man7: unify socket examples

The udp, tcp and x25 man pages' synopses list the socket() example as all bold, but the socket varname should be italicised. This change unifies these with the example in socket.7

---
 man7/tcp.7 | 2 +-
 man7/udp.7 | 2 +-
 man7/x25.7 | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
man7/tcp.7 +1 -1
index 0a7c61a37..c08bc7dcc 100644
@@ -102,7 +102,7 @@ tcp \- TCP protocol
 .B #include <netinet/in.h>
 .B #include <netinet/tcp.h>
 .PP
-.B tcp_socket = socket(AF_INET, SOCK_STREAM, 0);
+.IB tcp_socket " = socket(AF_INET, SOCK_STREAM, 0);"
 .fi
 .SH DESCRIPTION
 This is an implementation of the TCP protocol defined in
man7/udp.7 +1 -1
index a66e475cc..cd0937c53 100644
@@ -18,7 +18,7 @@ udp \- User Datagram Protocol for IPv4
 .B #include <netinet/in.h>
 .B #include <netinet/udp.h>
 .PP
-.B udp_socket = socket(AF_INET, SOCK_DGRAM, 0);
+.IB udp_socket " = socket(AF_INET, SOCK_DGRAM, 0);"
 .fi
 .SH DESCRIPTION
 This is an implementation of the User Datagram Protocol
man7/x25.7 +1 -1
index 561ed0519..e07e5f7a7 100644
@@ -17,7 +17,7 @@ x25 \- ITU-T X.25 / ISO-8208 protocol interface
 .B #include <sys/socket.h>
 .B #include <linux/x25.h>
 .PP
-.B x25_socket = socket(AF_X25, SOCK_SEQPACKET, 0);
+.IB x25_socket " = socket(AF_X25, SOCK_SEQPACKET, 0);"
 .fi
 .SH DESCRIPTION
 X25 sockets provide an interface to the X.25 packet layer protocol.
Signature · 1 line
2.30.2
#1 lore raw

Hi, Jeremy!

Quoted 5 lines · Jeremy Kerr

The udp, tcp and x25 man pages' synopses list the socket() example as all bold, but the socket varname should be italicised. This change unifies these with the example in socket.7

Thanks for these consistency fixes!

Cheers,

Alex

Quoted 46 lines
---
  man7/tcp.7 | 2 +-
  man7/udp.7 | 2 +-
  man7/x25.7 | 2 +-
  3 files changed, 3 insertions(+), 3 deletions(-)
man7/tcp.7 +1 -1
index 0a7c61a37..c08bc7dcc 100644
@@ -102,7 +102,7 @@ tcp \- TCP protocol
  .B #include <netinet/in.h>
  .B #include <netinet/tcp.h>
  .PP
-.B tcp_socket = socket(AF_INET, SOCK_STREAM, 0);
+.IB tcp_socket " = socket(AF_INET, SOCK_STREAM, 0);"
  .fi
  .SH DESCRIPTION
  This is an implementation of the TCP protocol defined in
man7/udp.7 +1 -1
index a66e475cc..cd0937c53 100644
@@ -18,7 +18,7 @@ udp \- User Datagram Protocol for IPv4
  .B #include <netinet/in.h>
  .B #include <netinet/udp.h>
  .PP
-.B udp_socket = socket(AF_INET, SOCK_DGRAM, 0);
+.IB udp_socket " = socket(AF_INET, SOCK_DGRAM, 0);"
  .fi
  .SH DESCRIPTION
  This is an implementation of the User Datagram Protocol
man7/x25.7 +1 -1
index 561ed0519..e07e5f7a7 100644
@@ -17,7 +17,7 @@ x25 \- ITU-T X.25 / ISO-8208 protocol interface
  .B #include <sys/socket.h>
  .B #include <linux/x25.h>
  .PP
-.B x25_socket = socket(AF_X25, SOCK_SEQPACKET, 0);
+.IB x25_socket " = socket(AF_X25, SOCK_SEQPACKET, 0);"
  .fi
  .SH DESCRIPTION
  X25 sockets provide an interface to the X.25 packet layer protocol.
Signature · 3 lines
Alejandro Colomar
Linux man-pages comaintainer; http://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
#2 lore raw
Quoted 10 lines · Alejandro Colomar (man-pages)

Hi, Jeremy!

Quoted 5 lines · Jeremy Kerr

The udp, tcp and x25 man pages' synopses list the socket() example as all bold, but the socket varname should be italicised. This change unifies these with the example in socket.7

Thanks for these consistency fixes!

And I forgot to explicitly say: patch applied :)

Quoted 52 lines

Cheers,

Alex

Quoted 46 lines

---

  man7/tcp.7 | 2 +-
  man7/udp.7 | 2 +-
  man7/x25.7 | 2 +-
  3 files changed, 3 insertions(+), 3 deletions(-)
man7/tcp.7 +0 -0
index 0a7c61a37..c08bc7dcc 100644
@@ -102,7 +102,7 @@ tcp \- TCP protocol

  .B #include <netinet/in.h>
  .B #include <netinet/tcp.h>
  .PP
-.B tcp_socket = socket(AF_INET, SOCK_STREAM, 0); +.IB tcp_socket " = socket(AF_INET, SOCK_STREAM, 0);" .fi
  .SH DESCRIPTION
  This is an implementation of the TCP protocol defined in

man7/udp.7 +0 -0
index a66e475cc..cd0937c53 100644
@@ -18,7 +18,7 @@ udp \- User Datagram Protocol for IPv4

  .B #include <netinet/in.h>
  .B #include <netinet/udp.h>
  .PP
-.B udp_socket = socket(AF_INET, SOCK_DGRAM, 0); +.IB udp_socket " = socket(AF_INET, SOCK_DGRAM, 0);" .fi
  .SH DESCRIPTION
  This is an implementation of the User Datagram Protocol

man7/x25.7 +0 -0
index 561ed0519..e07e5f7a7 100644
@@ -17,7 +17,7 @@ x25 \- ITU-T X.25 / ISO-8208 protocol interface

  .B #include <sys/socket.h>
  .B #include <linux/x25.h>
  .PP
-.B x25_socket = socket(AF_X25, SOCK_SEQPACKET, 0);
+.IB x25_socket " = socket(AF_X25, SOCK_SEQPACKET, 0);" .fi
  .SH DESCRIPTION
  X25 sockets provide an interface to the X.25 packet layer protocol.

Signature · 3 lines
Alejandro Colomar
Linux man-pages comaintainer; http://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/