[src/trunk]: src/lib/libc/net Update BUGS section to note the possibility of ...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/e8f2900d9f48
branches:  trunk
changeset: 819472:e8f2900d9f48
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Wed Dec 07 03:22:14 2016 +0000

description:
Update BUGS section to note the possibility of a truncated return value.

diffstat:

 lib/libc/net/linkaddr.3 |  8 ++++++--
 1 files changed, 6 insertions(+), 2 deletions(-)

diffs (29 lines):

diff -r 91493cb918f9 -r e8f2900d9f48 lib/libc/net/linkaddr.3
--- a/lib/libc/net/linkaddr.3   Wed Dec 07 03:16:45 2016 +0000
+++ b/lib/libc/net/linkaddr.3   Wed Dec 07 03:22:14 2016 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: linkaddr.3,v 1.10 2003/08/07 16:43:11 agc Exp $
+.\"    $NetBSD: linkaddr.3,v 1.11 2016/12/07 03:22:14 pgoyette Exp $
 .\"
 .\" Copyright (c) 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -32,7 +32,7 @@
 .\"
 .\"     @(#)linkaddr.3 8.1 (Berkeley) 7/28/93
 .\"
-.Dd July 28, 1993
+.Dd December 7, 2016
 .Dt LINK_ADDR 3
 .Os
 .Sh NAME
@@ -115,6 +115,10 @@
 The returned values for
 .Fn link_ntoa
 reside in a static memory area.
+If the returned value would overflow this area,
+.Fn link_ntoa
+truncates the returned string.
+There is no provision for detecting a truncated return value.
 .Pp
 The function
 .Fn link_addr