Commit Graph

1947 Commits

Author SHA1 Message Date
uqs
75c697f88d mdoc: reorder sections consistently 2011-06-02 09:56:53 +00:00
ru
2628ba45f7 [mdoc] Fixed .Dt call. 2011-05-25 14:13:53 +00:00
uqs
5179964e55 Re-encode files from ISO-8859-1 to UTF-8 2011-05-22 14:03:30 +00:00
phk
ef4a112671 When adding examples to man-pages, try to make them at least
look like they might work.

Prodded by:	Vadim Goncharov
2011-05-19 13:42:19 +00:00
phk
7fd3026923 Try to explain what sbufs do and add an example to show it.
Clarify return values.
2011-05-17 18:24:59 +00:00
ae
882d371a36 Add make_dev_alias_p to MLINKS.
Pointed out by:	pjd
MFC after:	2 weeks
2011-05-05 14:13:08 +00:00
ae
b550bd1bd7 Formatting fixes:
o Fix date
 o Break sentences
 o Remove trailing whitespaces
 o Sort xrefs by section number

Requested by:	ru
MFC after:	2 weeks
2011-05-05 09:55:55 +00:00
gjb
d357ee3b9f Remove unneeded tab after .Ed to make manlint happy.
Reported by:	manlint
2011-05-04 18:16:05 +00:00
ae
7f98cbc876 Document make_dev_alias_p().
MFC after:	2 weeks
2011-05-03 18:55:16 +00:00
jhb
deafe4e593 Add a new bus method, BUS_ADJUST_RESOURCE() that is intended to be a
wrapper around rman_adjust_resource().  Include a generic implementation,
bus_generic_adjust_resource() which passes the request up to the parent
bus.  There is currently no default implementation.  A
bus_adjust_resource() wrapper is provided for use in drivers.
2011-04-29 21:36:45 +00:00
jhb
22b381b721 Extend the rman(9) API to support altering an existing resource.
Specifically, these changes allow a resource to back a relocatable and
resizable resource such as the I/O window decoders in PCI-PCI bridges.
- rman_adjust_resource() can adjust the start and end address of an
  existing resource.  It only succeeds if the newly requested address
  space is already free.  It also supports shrinking a resource in
  which case the freed space will be marked unallocated in the rman.
- rman_first_free_region() and rman_last_free_region() return the
  start and end addresses for the first or last unallocated region in
  an rman, respectively.  This can be used to determine by how much
  the resource backing an rman must be adjusted to accomodate an
  allocation request that does not fit into the existing rman.

While here, document the rm_start and rm_end fields in struct rman,
rman_is_region_manager(), the bound argument to
rman_reserve_resource_bound(), and rman_init_from_resource().
2011-04-29 20:05:19 +00:00
des
fd9fc25d01 Rename alloc_unr(9) to unr(9) and adjust the links accordingly.
MFC after:	3 weeks
2011-04-27 01:10:15 +00:00
kib
18f7e5472c Document timeout_task.
While there, fix the type of the func argument of INIT_TASK macro,
and use the modern name of the analogous facility from Linux kernel.

Sponsored by:	The FreeBSD Foundation
MFC after:	1 month
2011-04-26 11:43:57 +00:00
glebius
5beb62e535 It is already seven years since mbuf allocator uses same
M_WAITOK/M_NOWAIT flags as malloc(9). Update manual page.

Submitted by:	Vadim Goncharov <vadimnuclight tpu.ru>
2011-04-18 15:30:25 +00:00
lstewart
545f7c0ca7 Use the full and proper company name for Swinburne University of Technology
throughout the source tree.

Requested by:	Grenville Armitage, Director of CAIA at Swinburne University of
			Technology
MFC after:	3 days
2011-04-12 08:13:18 +00:00
ae
87f996dde8 Remove duplicate sentence. 2011-03-30 11:34:40 +00:00
jkim
647cf29302 Fix a typo in the previous commit. AMD64 and Intel 64 are two brand names. 2011-03-15 17:59:30 +00:00
jkim
d3440080b0 Unconditionally use binuptime(9) for get_cyclecount(9) on i386. Since this
function is almost exclusively used for random harvesting, there is no need
for micro-optimization.  Adjust the manual page accordingly.
2011-03-15 17:14:26 +00:00
hselasky
f6b78c32dc - Add support for software pre-scaling of ISOCHRONOUS transfers.
MFC after:	14 days
Approved by:	thompsa (mentor)
2011-02-28 17:23:15 +00:00
lstewart
a3ab04ea2a Final commit to round out the "Five New TCP Congestion Control Algorithms for
FreeBSD" FreeBSD Foundation funded project.

- Add new man pages for the modular congestion control, Khelp and Hhook
  frameworks (cc.4, cc.9, khelp.9 and hhook.9).

- Add new man pages for each available congestion control algorithm (cc_chd.4,
  cc_cubic.4, cc_hd.4, cc_htcp.4, cc_newreno.4 and cc_vegas.4).

- Add a new man page for the Enhanced Round Trip Time (ERTT) Khelp module
  (h_ertt.4).

- Update the TCP (tcp.4) man page to mention the TCP_CONGESTION socket option,
  cross reference to cc.4 and remove references to the retired
  "net.inet.tcp.newreno" sysctl MIB variable.

In collaboration with:	David Hayes <dahayes at swin edu au> and
				Grenville Armitage <garmitage at swin edu au>
Sponsored by:	FreeBSD Foundation
MFC after:	3 months
2011-02-21 11:56:11 +00:00
imp
40fff8b4ec Document requirement that sys/types.h be included before rman.h.
Submitted by:	Raphael Kubo da Costa
MFC after:	2 weeks
2011-02-10 04:55:51 +00:00
mdf
7fc649fc41 Explicitly wire the user buffer rather than doing it implicitly in
sbuf_new_for_sysctl(9).  This allows using an sbuf with a SYSCTL_OUT
drain for extremely large amounts of data where the caller knows that
appropriate references are held, and sleeping is not an issue.

Inspired by:	rwatson
2011-01-27 00:34:12 +00:00
mdf
64c19cf589 Document sbuf_new_for_sysctl(9).
Pointed out by:	lstewart
2011-01-25 17:39:52 +00:00
jh
e2b6245a5d Fix typos. 2011-01-22 15:19:25 +00:00
mdf
6b5f615b7c Introduce signed and unsigned version of CTLTYPE_QUAD, renaming
existing uses.  Rename sysctl_handle_quad() to sysctl_handle_64().
2011-01-19 23:00:25 +00:00
jmg
b9c3284acc document that even when wakeup_one is used to wakeup, msleep and friends
may still return a non-zero value... You are not guaranteed to get a one
to one mapping between wakeup_one and zero return values...

Reviewed by:	kib
MFC after:	3 days
2011-01-19 22:16:42 +00:00
mdf
6648b8cede sysctl(8) should use the CTLTYPE to determine the type of data when
reading.  (This was already done for writing to a sysctl).  This
requires all SYSCTL setups to specify a type.  Most of them are now
checked at compile-time.

Remove SYSCTL_*X* sysctl additions as the print being in hex should be
controlled by the -x flag to sysctl(8).

Succested by:	bde
2011-01-19 17:04:07 +00:00
trasz
5b6a140b26 Restore comment describing /* NOTREACHED */, updated to match reality. 2011-01-07 08:34:12 +00:00
jhb
b80745da98 Retire the INTR_FAST flag as it was obsoleted by the introduction of the
filter argument to bus_setup_intr().
2011-01-06 21:14:34 +00:00
trasz
caf16f9aea Get rid of bad advice regarding /* NOTREACHED */. Compilers don't
really need it (one can use __dead2 instead), and style(9) was not
even consistent with itself in this regard.
2011-01-06 08:33:48 +00:00
lstewart
0bfe906525 Fix a whitespace nit.
MFC after:	1 week
X-MFC with:	r216995
2011-01-06 04:05:25 +00:00
lstewart
0e348d8b16 Add a man page for the Object Specific Data (OSD) KPI.
Although not directly related the FreeBSD Foundation funded "Five New TCP
Congestion Control Algorithms for FreeBSD" project, the understanding and
inspiration required to write this documentation was significantly bolstered
by the Foundation's support.

Reviewed by:	pjd
MFC after:	1 week
2011-01-05 11:49:23 +00:00
pjd
96b9ced89f Correct cookie type to match reality. 2010-12-19 18:07:10 +00:00
jhb
621c1b3562 Add a manpage for SYSINIT() and SYSUNINIT().
PR:		docs/132884
Submitted by:	pluknet, hmp
2010-12-06 15:19:03 +00:00
brucec
3e854ebf95 Document the fact that passing in a count of zero to the bus_space functions
will result in undefined behaviour.
Taken from NetBSD's bus_space(9).
2010-12-03 18:30:55 +00:00
brucec
6e3faf1602 Revert r216134. This checkin broke platforms where bus_space are macros:
they need to be a single statement, and do { } while (0) doesn't work in this
situation so revert until a solution can be devised.
2010-12-03 07:09:23 +00:00
brucec
dc1c4b9270 Disallow passing in a count of zero bytes to the bus_space(9) functions.
Passing a count of zero on i386 and amd64 for [I386|AMD64]_BUS_SPACE_MEM
causes a crash/hang since the 'loop' instruction decrements the counter
before checking if it's zero.

PR:	kern/80980
Discussed with:	jhb
2010-12-02 22:19:30 +00:00
kib
545c74c108 Remove the note about possible unlocking during vunref(9). It might
only happen if VOP_INACTIVATE() drops the vnode lock, which is quite
unreasonable behaviour for filesystem, and should not be mentioned
in the description of VFS primitives.

MFC after:	1 week
2010-11-24 12:34:25 +00:00
pluknet
a360d1cba6 Stop documenting vgonel() after its converting to the static function:
svn r147332 (by jeff): "Don't make vgonel() globally visible".
While here, specify the vnode locking scheme for vgone().

Discussed on:	freebsd-hackers@
Approved by:	kib (mentor)
MFC after:	10 days
2010-11-12 12:07:36 +00:00
mdf
ccbc087adc Add a taskqueue_cancel(9) to cancel a pending task without waiting for
it to run as taskqueue_drain(9) does.

Requested by:	hselasky
Original code:	jeff
Reviewed by:	jhb
MFC after:	2 weeks
2010-11-08 20:56:31 +00:00
trasz
c2febddc96 Xref BUS_SETUP_INTR(9) and locking(9). 2010-11-03 18:49:50 +00:00
jhb
8c8cb8e58a Fix a few typos and style nits in the example code.
Submitted by:	Arnaud Lacombe  lacombar of gmail
MFC after:	3 days
2010-11-02 12:40:13 +00:00
jh
d5b2b0a30f Use .Dv with NULL. 2010-10-24 16:10:32 +00:00
jh
8c0783a03a Document make_dev_p(9).
Reviewed by:	brueffer, kib
2010-10-24 15:56:21 +00:00
uqs
62105f8979 mdoc: make pages render with mandoc
It's a bit more pedantic regarding .Bl list elements. This has an added
benefit of unbreaking the ipfw(8) manpage, where groff was silently
skipping one list element.
2010-10-21 12:27:13 +00:00
avg
ceaa77fada catch up manual pages with rename of vm_page_sleep_busy to vm_page_sleep_if_busy
Suggested by:	alc
MFC after:	4 days
2010-10-20 06:29:11 +00:00
avg
2e7847beec VOP_GETPAGES.9: clarify and correct description of parameters and requirements
In cooperation with alc and kib, who provided valuable insights and
suggestions.

Reviewed by:	alc, kib (earlier version)
MFC after:	4 days
2010-10-20 05:57:54 +00:00
avg
9f9aed22bf PG_BUSY -> VPO_BUSY, PG_WANTED -> VPO_WANTED in manual pages and comments
Reviewed by:	alc
MFC after:	4 days
2010-10-20 05:17:23 +00:00
mdf
3f66b92677 uma_zfree(zone, NULL) should do nothing, to match free(9).
Noticed by:	Ron Steinke <rsteinke at isilon dot com>
MFC after:	3 days
2010-10-19 16:06:00 +00:00
uqs
f75a446d3c mdoc: fix markup typo
MFC after:	1 week (together with r213983)
2010-10-19 15:26:08 +00:00