Bug 65070

Summary: acct(2) patch
Product: Documentation Reporter: Marc Silver <marcs>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Marc Silver 2004-04-02 13:00:40 UTC
	The man page for acct(2) is missing information on certain
	sysctl(8) variables which affect process accounting.  It's also
	missing a link to the accton(8) command, which should be
	included, imho.

Fix: Apply the following patch:
How-To-Repeat: 	man 2 acct
Comment 1 Christian Brueffer 2004-04-16 01:38:02 UTC
On Fri, Apr 02, 2004 at 12:55:23PM +0100, Marc Silver wrote:

A few comments:

> 
> --- acct.2-orig	Fri Apr  2 12:35:55 2004
> +++ acct.2	Fri Apr  2 12:38:16 2004
> @@ -75,9 +75,27 @@
>  .Pp
>  This call is permitted only to the super-user.
>  .Sh NOTES
> -Accounting is automatically disabled when the file system the
> -accounting file resides on runs out of space; it is enabled when
> -space once again becomes available.
> +Accounting is automatically disabled when the file system the accounting
> +file resides on runs out of space; it is enabled when space once
> +again becomes available.  These values can be controlled using the


New sentences should start on new lines.  Also "these values" is a bit
misleading, we haven't talked about any values before.

> +following
> +.Xr sysctl 8
> +variables:
> +.Pp
> +.Bl -ohang -offset indent
> +.It kern.acct_chkfreq
> +.Pq Vt int
> +Specifies the frequency (in minutes) with which free disk
> +space should be checked.
> +.It kern.acct_resume
> +.Pq Vt int
> +The percentage of free disk space above which process
> +accounting will resume.
> +.It kern.acct_suspend
> +.Pq Vt int
> +The percentage of free disk space below which process
> +accounting will suspend.
> +.El


This is not very in line with the sysctl lists in other manpages.
What do you think about the following patch?

Index: acct.2
===================================================================
RCS file: /usr/home/ncvs/freebsd/src/lib/libc/sys/acct.2,v
retrieving revision 1.15
diff -u -r1.15 acct.2
--- acct.2      10 Sep 2003 19:24:33 -0000      1.15
+++ acct.2      16 Apr 2004 00:29:56 -0000
@@ -78,6 +78,21 @@
 Accounting is automatically disabled when the file system the
 accounting file resides on runs out of space; it is enabled when
 space once again becomes available.
+The values controlling this behaviour can be modified using the
following
+.Xr sysctl 8
+variables:
+.Pp
+.Bl -tag -width ".Va kern.acct_chkfreq"
+.It Va kern.acct_chkfreq
+Specifies the frequency (in minutes) with which free disk
+space should be checked.
+.It Va kern.acct_resume
+The percentage of free disk space above which process
+accounting will resume.
+.It Va kern.acct_suspend
+The percentage of free disk space below which process
+accounting will suspend.
+.El
 .Sh RETURN VALUES
 On error -1 is returned.
 The file must exist and the call may be exercised only by the
super-user.
@@ -112,6 +127,7 @@
 .El
 .Sh SEE ALSO
 .Xr acct 5 ,
+.Xr accton 8 ,
 .Xr sa 8
 .Sh HISTORY
 The


- Christian

-- 
Christian Brueffer	chris@unixpages.org	brueffer@FreeBSD.org
GPG Key:	 http://people.freebsd.org/~brueffer/brueffer.key.asc
GPG Fingerprint: A5C8 2099 19FF AACA F41B  B29B 6C76 178C A0ED 982D
Comment 2 Marc Silver 2004-04-16 12:05:13 UTC
On Friday, April 16, 2004 2:38 AM +0200 Christian Brueffer 
<chris@unixpages.org> wrote:
> New sentences should start on new lines.  Also "these values" is a bit
> misleading, we haven't talked about any values before.

Noted, thanks.

> This is not very in line with the sysctl lists in other manpages.

My apologies for that.  I used the layout from the sysctl (doctune) manual 
pages that I was helping Tom Rhodes with.

> What do you think about the following patch?

Fine with me.  :)  Thanks for looking at my submission.

Cheers,
Marc

-- 
Marc Silver         | OpenPGP fingerprint:       | DSA KeyID:
marcs@draenor.org   | 4622 621C C95F D2B5 EFDB   | 0x8BA8C548
                    | 6B75 EB16 C264 8BA8 C548   |
Comment 3 Christian Brueffer freebsd_committer freebsd_triage 2004-04-16 21:33:08 UTC
State Changed
From-To: open->closed

Committed the patch from the followup. 

Thanks for the work!