svn commit: r346251 - head/lib/libc/stdlib

[Conrad Meyer]

Author: cem
Date: Mon Apr 15 18:49:04 2019
New Revision: 346251
URL: https://svnweb.freebsd.org/changeset/base/346251

Log:
  random.3: Clarify confusing summary
  
  random.3 is only "better" in contrast to rand.3.  Both are non-cryptographic
  pseudo-random number generators.  The opening blurbs of each's DESCRIPTION
  section does emphasize this, and correctly directs unfamiliar developers to
  arc4random(3).  However, the summary (".Nd" or Name description) of random.3
  conflicted in tone and message with that warning.
  
  Resolve the conflict by clarifying in the Nd section that random(3) is
  non-cryptographic and pseudo-random.  Elide the "better" qualifier which
  implied a comparison but did not provide a specific object to contrast.
  
  Sponsored by:	Dell EMC Isilon

Modified:
  head/lib/libc/stdlib/random.3

Modified: head/lib/libc/stdlib/random.3
==============================================================================
--- head/lib/libc/stdlib/random.3	Mon Apr 15 18:40:36 2019	(r346250)
+++ head/lib/libc/stdlib/random.3	Mon Apr 15 18:49:04 2019	(r346251)
@@ -28,7 +28,7 @@
 .\"     @(#)random.3	8.1 (Berkeley) 6/4/93
 .\" $FreeBSD$
 .\"
-.Dd July 26, 2016
+.Dd April 15, 2019
 .Dt RANDOM 3
 .Os
 .Sh NAME
@@ -37,7 +37,7 @@
 .Nm srandomdev ,
 .Nm initstate ,
 .Nm setstate
-.Nd better random number generator; routines for changing generators
+.Nd non-cryptographic pseudorandom number generator; routines for changing generators
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS