* [PATCH] man7: unify socket examples
@ 2021-11-11 2:03 Jeremy Kerr
2021-11-11 20:13 ` Alejandro Colomar (man-pages)
0 siblings, 1 reply; 3+ messages in thread
From: Jeremy Kerr @ 2021-11-11 2:03 UTC (permalink / raw)
To: linux-man; +Cc: Alejandro Colomar, Michael Kerrisk
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
Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
---
man7/tcp.7 | 2 +-
man7/udp.7 | 2 +-
man7/x25.7 | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/man7/tcp.7 b/man7/tcp.7
index 0a7c61a37..c08bc7dcc 100644
--- a/man7/tcp.7
+++ b/man7/tcp.7
@@ -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
diff --git a/man7/udp.7 b/man7/udp.7
index a66e475cc..cd0937c53 100644
--- a/man7/udp.7
+++ b/man7/udp.7
@@ -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
diff --git a/man7/x25.7 b/man7/x25.7
index 561ed0519..e07e5f7a7 100644
--- a/man7/x25.7
+++ b/man7/x25.7
@@ -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.
--
2.30.2
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] man7: unify socket examples
2021-11-11 2:03 [PATCH] man7: unify socket examples Jeremy Kerr
@ 2021-11-11 20:13 ` Alejandro Colomar (man-pages)
2021-11-11 20:14 ` Alejandro Colomar (man-pages)
0 siblings, 1 reply; 3+ messages in thread
From: Alejandro Colomar (man-pages) @ 2021-11-11 20:13 UTC (permalink / raw)
To: Jeremy Kerr; +Cc: Michael Kerrisk, linux-man
Hi, Jeremy!
On 11/11/21 03:03, Jeremy Kerr wrote:
> 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
>
> Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
Thanks for these consistency fixes!
Cheers,
Alex
> ---
> man7/tcp.7 | 2 +-
> man7/udp.7 | 2 +-
> man7/x25.7 | 2 +-
> 3 files changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/man7/tcp.7 b/man7/tcp.7
> index 0a7c61a37..c08bc7dcc 100644
> --- a/man7/tcp.7
> +++ b/man7/tcp.7
> @@ -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
> diff --git a/man7/udp.7 b/man7/udp.7
> index a66e475cc..cd0937c53 100644
> --- a/man7/udp.7
> +++ b/man7/udp.7
> @@ -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
> diff --git a/man7/x25.7 b/man7/x25.7
> index 561ed0519..e07e5f7a7 100644
> --- a/man7/x25.7
> +++ b/man7/x25.7
> @@ -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.
>
--
Alejandro Colomar
Linux man-pages comaintainer; http://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] man7: unify socket examples
2021-11-11 20:13 ` Alejandro Colomar (man-pages)
@ 2021-11-11 20:14 ` Alejandro Colomar (man-pages)
0 siblings, 0 replies; 3+ messages in thread
From: Alejandro Colomar (man-pages) @ 2021-11-11 20:14 UTC (permalink / raw)
To: Jeremy Kerr; +Cc: Michael Kerrisk, linux-man
On 11/11/21 21:13, Alejandro Colomar (man-pages) wrote:
> Hi, Jeremy!
>
> On 11/11/21 03:03, Jeremy Kerr wrote:
>> 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
>>
>> Signed-off-by: Jeremy Kerr <jk@codeconstruct.com.au>
>
> Thanks for these consistency fixes!
And I forgot to explicitly say: patch applied :)
>
> Cheers,
>
> Alex
>
>> ---
>> man7/tcp.7 | 2 +-
>> man7/udp.7 | 2 +-
>> man7/x25.7 | 2 +-
>> 3 files changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/man7/tcp.7 b/man7/tcp.7
>> index 0a7c61a37..c08bc7dcc 100644
>> --- a/man7/tcp.7
>> +++ b/man7/tcp.7
>> @@ -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
>> diff --git a/man7/udp.7 b/man7/udp.7
>> index a66e475cc..cd0937c53 100644
>> --- a/man7/udp.7
>> +++ b/man7/udp.7
>> @@ -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
>> diff --git a/man7/x25.7 b/man7/x25.7
>> index 561ed0519..e07e5f7a7 100644
>> --- a/man7/x25.7
>> +++ b/man7/x25.7
>> @@ -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.
>>
>
--
Alejandro Colomar
Linux man-pages comaintainer; http://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-11-11 20:14 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-11 2:03 [PATCH] man7: unify socket examples Jeremy Kerr
2021-11-11 20:13 ` Alejandro Colomar (man-pages)
2021-11-11 20:14 ` Alejandro Colomar (man-pages)
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.