svn commit: r352372 - stable/12/lib/libc/sys

[Alan Somers]

Author: asomers
Date: Mon Sep 16 00:59:10 2019
New Revision: 352372
URL: https://svnweb.freebsd.org/changeset/base/352372

Log:
  MFC r352231:
  
  getsockopt.2: clarify that SO_TIMESTAMP is not 100% reliable
  
  When SO_TIMESTAMP is set, the kernel will attempt to attach a timestamp as
  ancillary data to each IP datagram that is received on the socket. However,
  it may fail, for example due to insufficient memory. In that case the
  packet will still be received but not timestamp will be attached.
  
  Reviewed by:	kib
  Differential Revision:	https://reviews.freebsd.org/D21607

Modified:
  stable/12/lib/libc/sys/getsockopt.2
Directory Properties:
  stable/12/   (props changed)

Modified: stable/12/lib/libc/sys/getsockopt.2
==============================================================================
--- stable/12/lib/libc/sys/getsockopt.2	Mon Sep 16 00:56:33 2019	(r352371)
+++ stable/12/lib/libc/sys/getsockopt.2	Mon Sep 16 00:59:10 2019	(r352372)
@@ -28,7 +28,7 @@
 .\"     @(#)getsockopt.2	8.4 (Berkeley) 5/2/95
 .\" $FreeBSD$
 .\"
-.Dd February 10, 2019
+.Dd September 11, 2019
 .Dt GETSOCKOPT 2
 .Os
 .Sh NAME
@@ -431,7 +431,8 @@ option is enabled on a
 .Dv SOCK_DGRAM
 socket, the
 .Xr recvmsg 2
-call will return a timestamp corresponding to when the datagram was received.
+call may return a timestamp corresponding to when the datagram was received.
+However, it may not, for example due to a resource shortage.
 The
 .Va msg_control
 field in the