[Bug 206040] sleepqueue man page describes priority arguments wrong.

[bugzilla-noreply at freebsd.org]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=206040

            Bug ID: 206040
           Summary: sleepqueue man page describes priority arguments
                    wrong.
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Documentation
          Assignee: freebsd-doc at FreeBSD.org
          Reporter: david.reed at tidalscale.com

sleepq_signal, sleepq_broadcast both take a "pri" argument.  The man page says
that if -1 is passed there will be no priority change, otherwise the pri value
will set the priority of all threads being signaled to pri.

However, if one looks at the code that uses the pri argument in sleepq_resume,
the actual logic can be described by this sentence:

"If pri is 0, the threads that are signaled will awake with priority unchanged.
Otherwise, if a thread is in priority class TIMESHARE, and a thread has a lower
TIMESHARE priority (larger value than pri) that thread's priority will be set
to pri. pri must either be between MIN_PRI and MAX_PRI, or zero."

I'd be happy if this simple fix to the document were made, and backported to
10.2 as well.  Feel free to use the wording above.

-- 
You are receiving this mail because:
You are the assignee for the bug.