Bug 28143

Summary: the Hz kernel config option is not documented
Product: Documentation Reporter: thierry <thierry>
Component: Books & ArticlesAssignee: Jeroen Ruigrok van der Werven <asmodai>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description thierry 2001-06-14 13:50:01 UTC
The Hz kernel config option is referenced in the ipfw(8) man page 
(typically 10ms, but it is a good practice to run kernels with 
``options HZ=1000'' to reduce the granularity to 1ms or less) but is
nowhere to be seen in the usual kernel config help file (aka LINT) or 
in a man page (and neither in the handbook).

I am using HZ=5000 in some (around 100) PCs here, with no ill effects. 
As this feature is a great win for xxBSD (for example for real-time 
systems), it should be documented.

Fix: 

Add a doc line in the LINT config file:
-----------------------------
options HZ=1000 # set the system clock to 1000 Hz 
                # (values above above 5000Hz should not be used)
-----------------------------
Comment 1 ru freebsd_committer freebsd_triage 2001-06-14 13:53:08 UTC
Responsible Changed
From-To: freebsd-doc->asmodai

Jeroen's commit to sys_i386_conf/NOTES,v 1.760 could be MFC'ed.
Comment 2 Jeroen Ruigrok van der Werven freebsd_committer freebsd_triage 2001-11-15 20:52:06 UTC
State Changed
From-To: open->closed

MFC'd to 4.4-STABLE as of today. 

Thanks!