From owner-freebsd-doc@FreeBSD.ORG Mon Mar 21 15:06:00 2011 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: by hub.freebsd.org (Postfix, from userid 1233) id EAC441065672; Mon, 21 Mar 2011 15:06:00 +0000 (UTC) Date: Mon, 21 Mar 2011 15:06:00 +0000 From: Alexander Best To: freebsd-doc@freebsd.org Message-ID: <20110321150600.GA16751@freebsd.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="YZ5djTAD1cGYuMQK" Content-Disposition: inline Subject: small correction to humanize_number(3) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 21 Mar 2011 15:06:01 -0000 --YZ5djTAD1cGYuMQK Content-Type: text/plain; charset=us-ascii Content-Disposition: inline hi there, could somebody please commit this fix? i don't think the date needs to be bumped. the first argument to humanize_number(3) is called "buf" and not "buffer". this patch corrects all the typos. cheers. alex -- a13x --YZ5djTAD1cGYuMQK Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="humanize_number.3.diff" diff --git a/lib/libutil/humanize_number.3 b/lib/libutil/humanize_number.3 index a4c3140..82925ba 100644 --- a/lib/libutil/humanize_number.3 +++ b/lib/libutil/humanize_number.3 @@ -49,12 +49,12 @@ The function formats the signed 64-bit quantity given in .Fa number into -.Fa buffer . +.Fa buf . A space and then .Fa suffix is appended to the end. The buffer pointed to by -.Fa buffer +.Fa buf must be at least .Fa len bytes long. @@ -62,7 +62,7 @@ bytes long. If the formatted number (including .Fa suffix ) would be too long to fit into -.Fa buffer , +.Fa buf , then divide .Fa number by 1024 until it will. @@ -91,7 +91,7 @@ The argument must be at least 4 plus the length of .Fa suffix , in order to ensure a useful result is generated into -.Fa buffer . +.Fa buf . To use a specific prefix, specify this as .Fa scale (multiplier = 1024 ^ scale). @@ -132,7 +132,7 @@ with 1000 instead of 1024. The .Fn humanize_number function returns the number of characters stored in -.Fa buffer +.Fa buf (excluding the terminating .Dv NUL ) upon success, or \-1 upon failure. --YZ5djTAD1cGYuMQK--