Commit Graph

368 Commits

Author SHA1 Message Date
Dag-Erling Smørgrav
c7ea226dc2 Document sysctl_move_oid(). 2004-02-27 17:13:42 +00:00
Pawel Jakub Dawidek
16710e88da Create symbolic link for g_print_bio(9) manual page.
Approved by:	scottl (mentor)
2004-02-11 18:43:20 +00:00
Pawel Jakub Dawidek
eb4f5d9df6 Added GEOM kernel API manuals to the build.
Reviewed by:	scottl
Approved by:	phk, scottl (mentor)
2004-02-11 10:09:17 +00:00
Dag-Erling Smørgrav
77c36c1710 Add a manual page for the mutex profiling code. 2004-01-25 12:23:53 +00:00
Ruslan Ermilov
b760de9691 Use a single style for share/man/ makefiles:
- Sort MAN and MLINKS in "dictionary" order ignoring case.

- For multi-value MAN and multi-pair MLINKS, put each value/pair
  on its own line, for easier sorting and so that further diffs
  are easier to see.
2004-01-20 10:27:23 +00:00
Robert Watson
9b1faf0afb Add a basic manpage for vn_fullpath().
Sponsored by:	DARPA, McAfee Research
2004-01-11 19:54:48 +00:00
Simon L. B. Nielsen
d42944a1b8 Add missing manual page links for rman(9) and sysctl_add_oid(9).
Submitted by:	Lukas Ertl <l.ertl@univie.ac.at>
PR:		docs/60088
2004-01-09 20:15:51 +00:00
Joseph Koshy
f096643b2d Document a few kernel functions and the sysctl tunables that
affect their behaviour.
2003-12-11 13:29:05 +00:00
Scott Long
4fb638c329 Add a manual page for the consolidated debugging commit. 2003-12-07 20:48:00 +00:00
Hiten Pandya
dab12c8eba Manual page for Asynchronous Logging Queues (ALQ) facility.
The manual page contains enough information to get someone started
with ALQ.

MLINKS have been added appropriately.

Approved by:	jeff, des
Reviewed by:	des, jeff, sam, brooks, rwatson, mtm
2003-11-10 22:45:09 +00:00
Warner Losh
302662db50 resource_query_string is dead. Kill it. 2003-11-05 04:36:13 +00:00
Bruce M Simpson
1aba005ab5 Add pmap_wired_count() and pmap_resident_count() to the pmap documentation.
Discussed with:	peter
2003-10-06 01:49:35 +00:00
Bruce M Simpson
cdf9f3771e Update the pmap(9) documentation to reflect the movement of pmap_prefault()
to the machine-independent VM layer, as per alc's recent commit.
Add a definition for the new pmap_is_prefaultable() helper function.
2003-10-04 01:30:01 +00:00
Bruce M Simpson
c753166c6a Add manual pages for the vm_map(9) part of the VM.
Reviewed by:	juli
Approved by:	jake (mentor)
2003-09-30 00:56:17 +00:00
Bruce M Simpson
7d216f0fa9 Add manual pages for the vm_map(9) part of the VM.
Reviewed by:    juli
Approved by:    jake (mentor)
2003-09-30 00:51:31 +00:00
Robert Watson
ef43d3b590 Documentation of kernel disk_create() and disk_destroy() APIs. These
APIs permit disk device drivers to register and deregister storage devices
for use by storage device consumers.  No doubt this API will change
more as time flies by, but this should be helpful to the creators of
new storage device drivers.

Reviewed by:	phk
2003-09-26 21:43:25 +00:00
Bruce M Simpson
2951193672 Fix MLINKS.
Noticed by:	bde
Pointy hat to:	bms
2003-09-25 23:44:15 +00:00
Bruce M Simpson
8019c643f1 Add manual page documentation for the machine-independent PMAP subsystem.
Include documentation of alc's new pmap_extract_and_hold() function.

Reviewed by:	hmp
Approved by:	jake (mentor)
2003-09-25 19:14:40 +00:00
Marcel Moolenaar
09d0a77ccd Hook up BUS_CONFIG_INTR.9 2003-09-24 05:18:41 +00:00
Hartmut Brandt
d7bbb21a9d Document uma_zone_set_max and its non-obvious behaviour.
Reviewed by:	bmilekic
2003-07-21 14:20:58 +00:00
Don Lewis
076c2f950a Document mutex pool API enhancements that allow creation and use of
multiple mutex pools.
2003-07-16 08:16:40 +00:00
Hartmut Brandt
7e9024cdd9 Add a facility for devices, specifically network interfaces, that require
large to huge amounts of small or medium sized receive buffers. The problem
with these situations is that they eat up the available DMA address space
very quickly when using mbufs or even mbuf clusters. Additionally this
facility provides a direct mapping between 32-bit integers and these buffers.
This is needed for devices originally designed for 32-bit systems. Ususally
the virtual address of the buffer is used as a handle to find the buffer as
soon as it is returned by the card. This does not work for 64-bit machines
and hence this mapping is needed.
2003-07-15 08:59:38 +00:00
Hiten Pandya
32c4d090ab Add MLINK for busdma(9) to bus_dma(9).
This resolves confusion for at least 10 people.

Suggested by:	Bruce M. Simpson <bms@spc.org>
Approved by:	des (mentor)
2003-06-17 19:50:59 +00:00
Hartmut Brandt
591f4054cb This is a driver for the physical layer chips used in ATM interfaces.
It currently supports the PMC Sierra Lite, Ultra and 622 chips and
the IDT 77105. The driver handles media options and state in a consistent
manner for ATM drivers. The next commit to the midway driver will make
it use utopia.
2003-06-12 14:28:32 +00:00
Hiten Pandya
33659d9aad Hook up pci(9) manual page to the build.
Approved by:	des (mentor)
2003-06-09 17:33:25 +00:00
Robert Watson
1792c88d10 Document VOP_LISTEXTATTR(9).
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-06-05 14:20:48 +00:00
Hiten Pandya
2450346579 Add the bus_dma(9) manual page to our section 9 collection. It
provides comprehensive documentation on FreeBSD's Bus DMA interface.

Approved by: gibbs, re@ (scottl)
Reviewed by: gibbs, scottl, des, sam, jake, tmm
2003-05-30 22:57:54 +00:00
Ruslan Ermilov
02531bb0b0 Link {be,le}{16,32,64}{enc,dec}.9 to byteorder.9.
Approved by:	re (blanket)
2003-05-21 17:37:22 +00:00
Hiten Pandya
5f616912b4 Document the ``resource management'' routines in rman(9).
Submitted by: Bruce M. Simpson <bms@spc.org>
Reviewed by: mdodd

Approved by: des (mentor), re (scottl)
2003-05-16 19:22:27 +00:00
Hiten Pandya
0d740fd5e8 Add a manual page for the CTASSERT(9) macro.
Approved by: des (mentor), re (scottl)
2003-05-16 15:24:07 +00:00
Hiten Pandya
03a0a09e98 Add missing MLINK for arc4rand(9). It is documented in
random(9) and referenced by gbde(4).

PR: docs/51254
Submitted by: Simon L. Nielsen <simon@nitro.dk>
Approved and Reviewed by: des (mentor), re (bmah)
2003-05-09 09:12:10 +00:00
Warner Losh
bf2331bae4 Document device_set_driver(9)
# now all driver_* functions used outside of subr_bus.o in my kernel
# are documented.
2003-04-22 03:43:44 +00:00
Warner Losh
6e684dce35 Document device_printf(9). 2003-04-22 03:32:31 +00:00
Warner Losh
c56c6bab42 Document device_set_ivars(9) as well. 2003-04-22 03:25:14 +00:00
Warner Losh
44d993e38a man page for device_get_parent. 2003-04-22 00:26:02 +00:00
Warner Losh
c82d43ff7a device_is_alive already was documented in device_get_state, so remove the
separate man page.  Document new device_is_attached there and remove that
new man page too.

Connect device_get_name to build, and install a link for
device_get_nameunit.

strangely nobody noticed this yet...
2003-04-22 00:21:28 +00:00
Warner Losh
41c44039c9 Simple man page for new device_is_attached. 2003-04-21 18:25:04 +00:00
Warner Losh
dd7520c9eb Add a man page for device_is_alive. 2003-04-21 18:24:05 +00:00
Warner Losh
d082b08904 Document what bus_set_resource(9) does. It is used by bus drivers to
bind resources that client drivers later access.
2003-03-30 00:25:23 +00:00
Kris Kennaway
6a897e3f7e Correct a typo in previous commit 2003-03-29 10:12:15 +00:00
Warner Losh
ec33f2d50f Add a new man page for bus_activate_resource and
bus_deactivate_resource.  It could use some improvement, and others
are welcomed to do so :-)
2003-03-29 05:16:15 +00:00
Warner Losh
9b89e63ce7 Create a man page for bus_child_present(9), a function to see if a
given device is considered accessible by its parent device bus driver
(or its parent, etc).
2003-03-28 07:09:17 +00:00
John Baldwin
7313b3d87e Remove obsolete at_fork() and at_exit() manpages. Curiously, at_exec()
didn't have a manpage.

Reminded by:	ru
2003-03-25 16:36:47 +00:00
Chris Costello
3ebc28efa8 Document the following MAC policies:
o Biba: A data integrity policy
o BSD Extended: Support for the firewall-like access controls (ugidfw(8))
o MLS: Multi-level security, a confidentiality policy

(These files originally lived in src/share/man/man9)

Approved by:	re (blanket)
Sponsored by:	DARPA, Network Associates Labs
Obtained from:	TrustedBSD Project
2002-12-05 00:05:38 +00:00
Chris Costello
431dda01b6 Document the MLS policy
Approved by:	re
Sponsored by:	DARPA, Network Associates Labs
Obtained from:	TrustedBSD Project
2002-12-02 01:04:37 +00:00
Chris Costello
2699228f1e Activate mac_biba.9
Approved by:	re
Sponsored by:	DARPA, Network Associates Labs
2002-11-20 22:28:20 +00:00
Robert Watson
64027e4d85 Add mac(9), a man page providing a basic introduction to the concepts
associated with the TrustedBSD MAC Framework, as well as some credits
to developers and contributors.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2002-10-21 23:51:18 +00:00
Chris Costello
6bc41f415a Add a new man page describing the mac_bsdextended policy.
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2002-10-18 05:40:48 +00:00
Mike Barcroft
31cfc49a4e Remove the posix4(9) manual. It no longer contains relevant
information.
2002-10-16 14:24:41 +00:00
Sam Leffler
f4bf433552 manual pages for the new kernel crypto support (need work)
Obtained from:	openbsd
2002-10-04 20:43:30 +00:00
Julian Elischer
a4fd02efc7 link in the man page for thread_exit
Also change some line breaks.
2002-07-08 17:52:00 +00:00
Kenneth D. Merry
98cb733c67 At long last, commit the zero copy sockets code.
MAKEDEV:	Add MAKEDEV glue for the ti(4) device nodes.

ti.4:		Update the ti(4) man page to include information on the
		TI_JUMBO_HDRSPLIT and TI_PRIVATE_JUMBOS kernel options,
		and also include information about the new character
		device interface and the associated ioctls.

man9/Makefile:	Add jumbo.9 and zero_copy.9 man pages and associated
		links.

jumbo.9:	New man page describing the jumbo buffer allocator
		interface and operation.

zero_copy.9:	New man page describing the general characteristics of
		the zero copy send and receive code, and what an
		application author should do to take advantage of the
		zero copy functionality.

NOTES:		Add entries for ZERO_COPY_SOCKETS, TI_PRIVATE_JUMBOS,
		TI_JUMBO_HDRSPLIT, MSIZE, and MCLSHIFT.

conf/files:	Add uipc_jumbo.c and uipc_cow.c.

conf/options:	Add the 5 options mentioned above.

kern_subr.c:	Receive side zero copy implementation.  This takes
		"disposable" pages attached to an mbuf, gives them to
		a user process, and then recycles the user's page.
		This is only active when ZERO_COPY_SOCKETS is turned on
		and the kern.ipc.zero_copy.receive sysctl variable is
		set to 1.

uipc_cow.c:	Send side zero copy functions.  Takes a page written
		by the user and maps it copy on write and assigns it
		kernel virtual address space.  Removes copy on write
		mapping once the buffer has been freed by the network
		stack.

uipc_jumbo.c:	Jumbo disposable page allocator code.  This allocates
		(optionally) disposable pages for network drivers that
		want to give the user the option of doing zero copy
		receive.

uipc_socket.c:	Add kern.ipc.zero_copy.{send,receive} sysctls that are
		enabled if ZERO_COPY_SOCKETS is turned on.

		Add zero copy send support to sosend() -- pages get
		mapped into the kernel instead of getting copied if
		they meet size and alignment restrictions.

uipc_syscalls.c:Un-staticize some of the sf* functions so that they
		can be used elsewhere.  (uipc_cow.c)

if_media.c:	In the SIOCGIFMEDIA ioctl in ifmedia_ioctl(), avoid
		calling malloc() with M_WAITOK.  Return an error if
		the M_NOWAIT malloc fails.

		The ti(4) driver and the wi(4) driver, at least, call
		this with a mutex held.  This causes witness warnings
		for 'ifconfig -a' with a wi(4) or ti(4) board in the
		system.  (I've only verified for ti(4)).

ip_output.c:	Fragment large datagrams so that each segment contains
		a multiple of PAGE_SIZE amount of data plus headers.
		This allows the receiver to potentially do page
		flipping on receives.

if_ti.c:	Add zero copy receive support to the ti(4) driver.  If
		TI_PRIVATE_JUMBOS is not defined, it now uses the
		jumbo(9) buffer allocator for jumbo receive buffers.

		Add a new character device interface for the ti(4)
		driver for the new debugging interface.  This allows
		(a patched version of) gdb to talk to the Tigon board
		and debug the firmware.  There are also a few additional
		debugging ioctls available through this interface.

		Add header splitting support to the ti(4) driver.

		Tweak some of the default interrupt coalescing
		parameters to more useful defaults.

		Add hooks for supporting transmit flow control, but
		leave it turned off with a comment describing why it
		is turned off.

if_tireg.h:	Change the firmware rev to 12.4.11, since we're really
		at 12.4.11 plus fixes from 12.4.13.

		Add defines needed for debugging.

		Remove the ti_stats structure, it is now defined in
		sys/tiio.h.

ti_fw.h:	12.4.11 firmware.

ti_fw2.h:	12.4.11 firmware, plus selected fixes from 12.4.13,
		and my header splitting patches.  Revision 12.4.13
		doesn't handle 10/100 negotiation properly.  (This
		firmware is the same as what was in the tree previously,
		with the addition of header splitting support.)

sys/jumbo.h:	Jumbo buffer allocator interface.

sys/mbuf.h:	Add a new external mbuf type, EXT_DISPOSABLE, to
		indicate that the payload buffer can be thrown away /
		flipped to a userland process.

socketvar.h:	Add prototype for socow_setup.

tiio.h:		ioctl interface to the character portion of the ti(4)
		driver, plus associated structure/type definitions.

uio.h:		Change prototype for uiomoveco() so that we'll know
		whether the source page is disposable.

ufs_readwrite.c:Update for new prototype of uiomoveco().

vm_fault.c:	In vm_fault(), check to see whether we need to do a page
		based copy on write fault.

vm_object.c:	Add a new function, vm_object_allocate_wait().  This
		does the same thing that vm_object allocate does, except
		that it gives the caller the opportunity to specify whether
		it should wait on the uma_zalloc() of the object structre.

		This allows vm objects to be allocated while holding a
		mutex.  (Without generating WITNESS warnings.)

		vm_object_allocate() is implemented as a call to
		vm_object_allocate_wait() with the malloc flag set to
		M_WAITOK.

vm_object.h:	Add prototype for vm_object_allocate_wait().

vm_page.c:	Add page-based copy on write setup, clear and fault
		routines.

vm_page.h:	Add page based COW function prototypes and variable in
		the vm_page structure.

Many thanks to Drew Gallatin, who wrote the zero copy send and receive
code, and to all the other folks who have tested and reviewed this code
over the years.
2002-06-26 03:37:47 +00:00
Chad David
920a6f7e8f Add signal.9 and friends. 2002-06-10 03:01:36 +00:00
Jeroen Ruigrok van der Werven
382682b2a4 Add description for uma_zcreate().
Submitted by:	arr
2002-05-18 11:12:02 +00:00
Jeroen Ruigrok van der Werven
7c32182e06 Prefix the remaining functions with uma_ as is now the case in UMA. 2002-04-30 12:45:31 +00:00
Jeroen Ruigrok van der Werven
2f91527664 zinit() does not exist anymore. 2002-04-30 12:29:59 +00:00
Jeroen Ruigrok van der Werven
9daecfc462 Add a MLINKS to uma.9 from zone.9. 2002-04-30 09:41:25 +00:00
Jeroen Ruigrok van der Werven
268c1b9c75 Remove MLINKS to zinitna, it does not exist anymore. 2002-04-30 09:38:06 +00:00
Jeroen Ruigrok van der Werven
c25d2ac8cb Remove MLINKS to zbootinit. This has been gone for a while now. 2002-04-30 09:36:02 +00:00
Mike Barcroft
aabc5d3d44 Add links for bswap16.9, bswap32.9, and bswap64.9. 2002-04-29 17:04:23 +00:00
Chad David
468f8a27bb Add entries for selrecord.9. 2002-04-12 06:19:34 +00:00
Andrew R. Reiter
80cc42da6b - Add notes about SX_SYSINIT and MTX_SYSINIT in order to document the
recent additions of these macros.
- Add in a MLINK to create SX_SYSINIT.9 and MTX_SYSINIT.9.
2002-04-02 17:21:00 +00:00
John Baldwin
cfa028281a - Update to new suser() API.
- Spell privilege properly.
- Grammar nits.
2002-04-02 16:41:11 +00:00
Dima Dorfman
aa43564a2c Add a manual page for the mtx_pool_* routines.
PR:		36350
Submitted by:	Garrett Rooney <rooneg@electricjellyfish.net>
Reviewed by:	dillon
2002-03-28 12:50:17 +00:00
Archie Cobbs
44a8ff315e Add realloc() and reallocf(), and make free(NULL, ...) acceptable.
Reviewed by:	alfred
2002-03-13 01:42:33 +00:00
Mike Barcroft
8a1791edf4 Create a manual to document the new kernel byte order conversion
functions.

Reviewed by:	tmm
2002-03-06 01:53:35 +00:00
Dima Dorfman
0db0f1925a Document cru2x(). 2002-03-03 03:27:28 +00:00
Dima Dorfman
44c63b6447 The routine is dev_depends(); consistently spell it that way.
PR:		34047
Submitted by:	Maxime Henrion <mux@sneakerz.org>
Pointy hat to:	dd
2002-02-11 01:21:29 +00:00
Mark Murray
be6b96ea0b Document entropy device bits. 2002-02-06 21:38:20 +00:00
Brian Feldman
a15fa068ab Add a manpage for VOP_REVOKE(9).
Sponsored by:	DARPA, NAI Labs
2002-02-05 16:08:49 +00:00
Chad David
5385e8bfab Merged all of the lockmgr functions into a single file (lock.9); as well,
some content and layout changes were made.

lock.9 had existed before but was never added to Makefile, so it was
never installed.  That is why the duplicate files were created in the
first place.

Reviewed by:	ru, alfred
2002-01-26 00:09:41 +00:00
Ruslan Ermilov
48ad35449f get_cyclecounter.9 has been repo-copied to get_cyclecount.9. 2002-01-10 12:21:06 +00:00
Kelly Yancey
371c0c842a Document sbuf_trim() and sbuf_vprintf(); add MLINKs.
Clarify that the contents of a caller-supplied buffer are undefined and
should not be examined directly.

Reviewed by:	des
2002-01-06 08:40:42 +00:00
John Baldwin
e5b4afac08 Fully catch up to the recent critical section API change. Update the
content of the manpage and document cpu_critical_enter/exit.
2002-01-04 23:56:17 +00:00
Chad David
f4af1f0785 Add a man page describing the fuctions directly related to network domains.
Reviewed by: alfred
2001-12-07 20:58:07 +00:00
Alfred Perlstein
ffc0b97fd0 More kernel vfs docco.
Xref vfs_mount(9) from vfs_mount(9)

Submitted by: Chad David <davidc@acns.ab.ca>
PR: docs/32431
2001-12-03 00:25:04 +00:00
Alfred Perlstein
2164257702 Add manpages describing various vfs and vm APIs.
Submitted by: Chad David <davidc@acns.ab.ca>
2001-12-02 02:13:35 +00:00
Ruslan Ermilov
57813e7f3f Bring the ucred(9) manpage in sync with the source.
Specifically, document the crshared() function and
fix the prototype and description of the crcopy()
function.

PR:		docs/32275
Submitted by:	Chad David <davidc@acns.ab.ca>
Reviewed by:	jhb
2001-11-26 18:37:50 +00:00
John Baldwin
7fe151bee5 Document sx_assert(9). 2001-10-23 22:51:59 +00:00
Bruce Evans
9bcf4808fb Second round of spelling fixes for vm_page_io_finised. The function name
is actually vm_page_io_finish.
2001-10-04 10:10:56 +00:00
Bruce Evans
f350e13c63 Removed garbage:
- bus_generic_map_intr.9.  This has been undead for more than 3 years
  following the changes in rev.1.4 of sys/bus.h.
- CONDSPLASSERT.9, SPLASSERT.9.  These have been undead since SMPng.
  They were even less useful than most section 9 man pages -- the
  interfaces described in them have never been used in the FreeBSD
  source tree.
2001-10-04 09:46:01 +00:00
Dag-Erling Smørgrav
320adc96d0 Token man page for pseudofs(9). 2001-09-30 18:07:55 +00:00
Robert Watson
c369ba597d o Attach vaccess_acl_posix1e.9 to the build.
o Cross-reference vaccess_acl_posix1e.9 from vaccess.9.

Obtained from:	TrustedBSD Project
2001-08-27 17:45:06 +00:00
Robert Watson
3f61520e73 o Hook up vaccess.9 to the build.
Submitted by:	ru
2001-08-27 13:57:49 +00:00
John Baldwin
b4e95913f7 Remove references to asleep/await. 2001-08-23 23:37:31 +00:00
Alexander Langer
088be0c610 Link MULTI_DRIVER_MODULE.9 to DRIVER_MODULE.9 2001-08-21 22:17:47 +00:00
Jason Evans
54db32e945 Implement kernel semaphores.
Reviewed by:	jhb
2001-08-14 22:13:14 +00:00
Jason Evans
d55229b72e Add sx_try_upgrade() and sx_downgrade().
Submitted by:	Alexander Kabaev <ak03@gte.com>
2001-08-13 21:25:30 +00:00
Ruslan Ermilov
033e89ed31 Add manpage for pgfind(9).
PR:		docs/29552
Submitted by:	Evan Sarmiento <kaworu@sektor7.ath.cx>
2001-08-10 07:19:55 +00:00
Thomas Moestl
5ca0c84eaa Document zdestroy().
Reviewed by:	des
2001-08-09 16:01:27 +00:00
Ruslan Ermilov
92d3777cdd s/vm_page_io_finised/vm_page_io_finished/
Submitted by:	Chad David <davidc@colnta.acns.ab.ca>
2001-08-08 08:27:19 +00:00
Jason Evans
920ae52d67 Document sx_try_[sx]lock(). 2001-08-07 04:29:53 +00:00
Alfred Perlstein
0a6ca2a733 More updates from Chad.
Submitted by: Chad David <davidc@acns.ab.ca>
Reviewed by: sheldonh
2001-07-30 22:14:23 +00:00
Chris Costello
2ec27ccd83 Add a short man page describing the vfs_unmountall() function.
MFC after:	1 week
2001-07-27 03:54:59 +00:00
Alfred Perlstein
609ad476a3 Install and provide MLINKS for:
pbuf.9 vm_page_alloc.9 vm_page_copy.9 vm_page_flag.9 vm_page_hold.9
 vm_page_insert.9 vm_page_io.9 vm_page_lookup.9 vm_page_protect.9
 vm_page_sleep_busy.9 vm_page_wakeup.9 vm_page_wire.9
 vm_page_zero_fill.9 vm_set_page_size.9
2001-07-18 06:10:33 +00:00
Ruslan Ermilov
17a3206c22 Manpage for pfind() and zpfind().
Submitted by:	Evan Sarmiento <kaworu@sektor7.ath.cx>
2001-07-16 07:04:09 +00:00
Jens Schweikhardt
c1f3e4bf21 Removed whitespace at end-of-line; no content changes. I simply did
cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//'

BTW, what editors are the culprits? I'm using vim and it shows
me whitespace at EOL in troff files with a thick blue block...

Reviewed by:	Silence from cvs diff -b
MFC after:	7 days
2001-07-14 19:41:16 +00:00
Ruslan Ermilov
4772483c00 Add a few more manpages from Chad.
Fold major.9, minor.9, umajor.9, and uminor.9 into a single device_ids.9.
2001-07-13 18:35:48 +00:00
Alfred Perlstein
d248afb3b2 Sort MAN= section. 2001-07-10 07:42:35 +00:00
Alfred Perlstein
8adb2d7b0e Install:
cdevsw_add.9 cdevsw_remove.9 devsw.9
major.9 minor.9 umajor.9 uminor.9 vn_isdisk.9
2001-07-10 07:28:11 +00:00
Alfred Perlstein
5c5e4328d3 Link in new manpages:
BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9
BUF_REFCNT.9 BUF_TIMELOCK.9 BUF_UNLOCK.9
lockcount.9 lockdestroy.9 lockmgr.9 lockmgr_printinfo.9 lockstatus.9
2001-07-10 04:35:22 +00:00
Alfred Perlstein
ffe734e3a2 Link in manpages for vfs_busy, vfs_mount, vfs_unbusy, and vinvalbuf. 2001-07-09 07:15:51 +00:00
John Baldwin
a1382e7fd2 Add a new manpage to document the CTRx macros used when adding new KTR
tracepoints to kernel code.
2001-06-28 07:20:05 +00:00
Dima Dorfman
8a6ecebcdf Link make_dev.9 to make_dev_alias.9 and depends_dev.9. 2001-05-29 04:17:36 +00:00
Dima Dorfman
a19771414c Remove obsolete DEVFS manual pages. The routines they describe don't
exist in the new (phk's) DEVFS.

Approved by:	phk
2001-05-28 20:27:23 +00:00
Dima Dorfman
1f7eace1d1 Add printf.9, and add links to tprintf.9 and uprintf.9. 2001-05-05 00:25:39 +00:00
Alexander Langer
50c39ea7a5 Add SYSCALL_MODULE.9, a manpage for the SYSCALL_MODULE wrapper macro
for syscall klds.

Some text of this manpage is based on the comments in the example
syscall module written by Assar Westerlund.

Reviewed by:	ru
2001-04-28 13:18:40 +00:00
John Baldwin
1c39cfb650 Correct the MLINKS for mutex.9 to reflect the API change and add a new
MLINK for mtx_initialized.

Reminded by:	rwatson
2001-03-30 23:00:00 +00:00
John Baldwin
5ecf40428d Add a manpage for the critical_enter/exit() functions. 2001-03-28 07:30:58 +00:00
Ruslan Ermilov
acaf79e1b9 MAN[1-9] -> MAN. 2001-03-27 13:48:25 +00:00
Alexander Langer
74169a2c54 Add a manpage for the DEV_MODULE kernel macro. 2001-03-11 17:30:08 +00:00
Alexander Langer
ed488dd0c8 Add MODULE_DEPEND.9 and MODULE_VERSION.9 2001-03-11 14:42:38 +00:00
Alexander Langer
448be9f93c Add DEVICE_IDENTIFY.9 2001-03-10 19:37:27 +00:00
Boris Popov
a1a5ca5514 Add documentation for mchain API.
Reviewed by:	asmodai, ru (mbchain.9)
2001-03-10 06:10:48 +00:00
Alexander Langer
85ac71e9c6 Add module.9 and DECLARE_MODULE.9 2001-03-09 14:16:46 +00:00
John Baldwin
ebadd4f5b1 Document the ithread_* API used to manage interrupt threads and their
list of handlers.
2001-03-09 03:30:20 +00:00
John Baldwin
3d92386026 Adjust swi.9 MLINKS to catch up to the new swi API. 2001-03-05 23:48:38 +00:00
Jason Evans
6281b30a73 Implement shared/exclusive locks.
Reviewed by:	bmilekic, jake, jhb
2001-03-05 19:59:41 +00:00
Mark Murray
f4e8d446d8 Extra MLINKS to reflect expansion of BUS_SETUP_INTR(9) manpage. 2001-03-03 14:19:39 +00:00
Warner Losh
6e5801f1af Add link for resource_query_unit, now documented in the
resource_query_string man page.
2001-03-02 04:32:50 +00:00
Jeroen Ruigrok van der Werven
392651edbe Hook Warner's resource_* manpages to the build.
This includes appropriate MLINKS for the other functions contained
within them.
2001-03-01 09:06:57 +00:00
Boris Popov
c7adfa9cf9 Add man page for VOP_GETVOBJECT, VOP_CREATEVOBJECT and VOP_DESTROYVOBJECT
operations.

Reviewed by:	sheldonh
2001-02-06 10:33:37 +00:00
Jeroen Ruigrok van der Werven
bcf588d94e Add vcount.9 / count_dev.9.
Touched up a bit and added some consistency to the text by your's truly.

PR:		23745
Submitted by:	Andrew Stevenson <andrew@ugh.net.au>
2001-02-06 09:04:52 +00:00
Bruce Evans
4d5a3a7a50 Removed vestiges of vop_mmap. 2001-02-02 12:51:22 +00:00
Dag-Erling Smørgrav
ea48868bf6 Add MLINKS for sbuf_clear() and sbuf_overflowed(). 2001-01-28 00:19:10 +00:00
Dag-Erling Smørgrav
0aa028ffe9 Add a man page for the zone allocator. 2001-01-27 19:13:08 +00:00
John Baldwin
ef7b803dcd - Activate runqueue.9, scheduler.9, and sleepqueue.9 along with appropriate
MLINKS.
- Update MLINKS for mi_switch.9.
2001-01-23 19:38:45 +00:00
Jason Evans
d1c1b8413e Remove MUTEX_DECLARE() and MTX_COLD. Instead, postpone full mutex
initialization until after malloc() is safe to call, then iterate through
all mutexes and complete their initialization.

This change is necessary in order to avoid some circular bootstrapping
dependencies.
2001-01-21 07:52:20 +00:00
Jason Evans
238510fc46 Implement condition variables. 2001-01-16 01:00:43 +00:00
John Baldwin
aea5b8ffe1 Catch up to the changes to the kthread API. 2000-12-15 20:39:35 +00:00
Dag-Erling Smørgrav
863edaec4d Add sbuf(9) man page with links to API function names.
Reviewed by:	ru
2000-12-13 19:53:37 +00:00
Alfred Perlstein
a0ae47cd48 Install DELAY(9). 2000-11-22 03:44:55 +00:00
Mark Murray
a28724c2c2 Add new man page to the mix. 2000-11-21 20:31:51 +00:00
Mark Murray
6323c703f7 Whitespace-only change. Tidy up, alphabetise and wrap. 2000-11-21 20:28:48 +00:00
Alfred Perlstein
a984db451a install/build accf_* manpages 2000-11-16 00:57:52 +00:00
John Baldwin
ab7e1991c0 Beef up the description of the kernel thread API.
Reviewed by:	sheldonh, jasone
2000-11-13 20:34:20 +00:00
John Baldwin
dc4e9f1a03 Describe the new software interrupt thread functionality.
Reviewed by:	sheldonh, jasone
2000-11-13 20:18:42 +00:00
John Baldwin
eaca618337 Add a manpage to document the atomic operations including a quick treatment
of memory barriers and the newish atomic variants that include them.

Reviewed by:	sheldonh
2000-11-13 20:08:17 +00:00
Ruslan Ermilov
dc5a40409d Add pfil.9 manpage to build after a repository copy. 2000-10-30 09:16:18 +00:00
John Baldwin
7dbdc1bff4 Add in MLINKS for all of the various mutex functions to mutex.9 2000-10-26 23:54:10 +00:00
Nik Clayton
de06f907d1 Add a prototype mbuf.9 man page. Probably needs work, but it's a good
start.

PR:             docs/22053
Submitted by:   Yar Tikhiy <yar@comp.chem.msu.su>
2000-10-26 23:15:47 +00:00
Mark Murray
67297998c8 Add a man page for part of the PRNG API. 2000-10-14 16:16:42 +00:00
Brian Somers
e6e7337683 Index: Makefile
===================================================================
RCS file: /home/ncvs/src/share/man/man9/Makefile,v
retrieving revision 1.75
diff -u -r1.75 Makefile
--- Makefile	2000/09/17 12:15:12	1.75
+++ Makefile	2000/10/06 23:24:26
@@ -69,6 +69,8 @@
 MLINKS+=make_dev.9 destroy_dev.9
 MLINKS+=malloc.9 FREE.9 malloc.9 MALLOC.9 malloc.9 free.9
 MLINKS+=mi_switch.9 cpu_switch.9
+MLINKS+=namei.9 NDINIT.9
+MLINKS+=namei.9 NDFREE.9
 MLINKS+=posix4.9 p1003_1b.9
 MLINKS+=psignal.9 gsignal.9 psignal.9 pgsignal.9
 MLINKS+=rtalloc.9 rtalloc1.9 rtalloc.9 rtalloc_ign.9
2000-10-06 23:29:11 +00:00
Alexander Langer
72f8c78baf Add DRIVER_MODULE.9, the manual page describing the kernel driver
declaration macro.
Thanks to Sheldon for a big patch with language/mdoc fixes.

Reviewed by:	asmodai, sheldonh
2000-09-17 12:15:12 +00:00
Jake Burkholder
e66ccea4a1 Add scant documentation for msleep. 2000-09-11 00:52:31 +00:00
Jason Evans
0384fff8c5 Major update to the way synchronization is done in the kernel. Highlights
include:

* Mutual exclusion is used instead of spl*().  See mutex(9).  (Note: The
  alpha port is still in transition and currently uses both.)

* Per-CPU idle processes.

* Interrupts are run in their own separate kernel threads and can be
  preempted (i386 only).

Partially contributed by:	BSDi (BSD/OS)
Submissions by (at least):	cp, dfr, dillon, grog, jake, jhb, sheldonh
2000-09-07 01:33:02 +00:00
Doug Rabson
21c58b8d40 Document kobj_class_compile_static(). 2000-08-28 21:17:46 +00:00
Mark Murray
58ea82758e Mention more functions in the headers so whatis(1) can find them, and
create links to functions so added found.
2000-08-16 19:53:38 +00:00
Andrzej Bialecki
bd3cdc3105 These patches implement dynamic sysctls. It's possible now to add
and remove sysctl oids at will during runtime - they don't rely on
linker sets. Also, the node oids can be referenced by more than
one kernel user, which means that it's possible to create partially
overlapping trees.

Add sysctl contexts to help programmers manage multiple dynamic
oids in convenient way.

Please see the manpages for detailed discussion, and example module
for typical use.

This work is based on ideas and code snippets coming from many
people, among them:  Arun Sharma, Jonathan Lemon, Doug Rabson,
Brian Feldman, Kelly Yancey, Poul-Henning Kamp and others. I'd like
to specially thank Brian Feldman for detailed review and style
fixes.

PR:		kern/16928
Reviewed by:	dfr, green, phk
2000-07-15 10:26:04 +00:00
Jeroen Ruigrok van der Werven
7bca8b217f Install accept_filter.9
Forgotten by:	alfred
2000-07-11 13:50:04 +00:00
Alexander Langer
9092a4bca7 Add bus_alloc_resource.9 and bus_release_resource.9.
bus_release_resource.9 contains a paragraph obtained from a mail
by Warner Losh <imp@FreeBSD.org> to myself.

Reviewed by:	asmodai, hoek;  in parts by msmith, mdodd and imp
2000-06-08 21:00:12 +00:00
Doug Rabson
823234556f Add documentation for taskqueue apis. 2000-05-28 16:53:50 +00:00
Doug Rabson
c685012659 Add manpage for kernel object system. 2000-04-08 13:24:40 +00:00
Jeroen Ruigrok van der Werven
42a3fc35e6 Add and install BUS_SETUP_INTR.9.
This effectively replaces BUS_CREATE_INTR.9 and BUS_CONNECT_INTR.9.

Reviewed by:	n_hibma
2000-04-02 12:00:52 +00:00
Jeroen Ruigrok van der Werven
03be717064 Get rid of the manpages for BUS_CREATE_INTR() and BUS_CONNECT_INTR().
These got replaced by BUS_SETUP_INTR().

This once again illustrates an API change without informing -doc, so
that these sort post cleanup actions could've been avoided.

And then people wonder why the docs suck so much at times.

Reviewed by:	peter
2000-04-02 09:25:15 +00:00
Bruce Evans
084f33c228 Actually install KASSERT.9. 2000-03-20 20:23:43 +00:00
Jeroen Ruigrok van der Werven
2e6b4dc303 Add the manpage for CONDSPLASSERT().
This was based upon the manpage written by jmb for SPLASSERT().
2000-03-19 14:43:03 +00:00
Jeroen Ruigrok van der Werven
5eca43faa9 After about two months I am the first to notice that SPLASERT.9 never
got installed.

Also, correct the copyright to a more realistic date (1996->2000).
Fix some wordings and omissions.
2000-03-18 21:51:16 +00:00
Alexey Zelkin
ae5ccfad91 Add new manpages for:
microtime(9)
	nanotime(9)
	getmicrotime(9)
	getnanotime(9)
	microuptime(9)
	nanouptime(9)
	getmicrouptime(9)
	getnanouptime(9)
	tvtohz(9)

Based on PR:	docs/15889
Submitted by:	Kelly Yancey <kbyanc@posi.net>
2000-01-07 12:42:59 +00:00
Robert Watson
32900e82f3 Man pages for the VFS extended attribute and access control list vnops.
Reviewed by:	eivind
2000-01-05 04:59:02 +00:00
Bruce Evans
bd00dbfafc "Fixed" assorted bitrot. remove_dev() was renamed to destroy_dev().
VOP_ABORTOP() went away.  at_shutdown() was replaced by undocumented
event handling.  Rename remove_dev() here too, and remove the dead
and dead wrong man pages.
1999-12-23 17:16:32 +00:00
Nick Hibma
fa930a7361 Add the device_get_children(9) man page. 1999-12-02 16:34:09 +00:00
Chris Costello
94b1839d20 Document the make_dev(9) and remove_dev(9) facilities.
remove_dev(9) is created as a link to the existing make_dev(9) page.

Reviewed by:	phk
1999-09-25 20:12:01 +00:00
Chris Costello
2da64d5dd7 Document the devtoname(9) kernel interface. 1999-09-25 15:58:33 +00:00
Matthew Dillon
37af288330 More locking clarifications. Add skeleton manual page for VOP_LEASE 1999-09-24 17:11:02 +00:00
Doug Rabson
57129f42d5 Add new manpage device_set_flags.9 and add links for
device_set_desc_copy.9 and device_get_flags.9.
1999-09-12 16:01:11 +00:00
Chris Costello
7ad5ee3757 Add a link for uiomove.9 to uio.9 1999-09-11 15:39:31 +00:00
Alfred Perlstein
fb6d83aa60 Document VFS changes:
VFS_CHECKEXP.9, now used to check export credentials
VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done.
VFS.9, inform people of the vfs_std* functions available to avoid
       ugly casts to eopnotsup and making of dummy functions to return 0.
1999-09-11 00:57:20 +00:00
Alexey Zelkin
0d28dd1dc5 Replace stale references to device_add_child_after(9) with
device_child_add_ordered(9)

PR:		13210
Submitted by:	Alexey Zelkin <phantom@cris.net>
Reviewed by:	mpp
Forgotten by:	dfr
1999-09-04 12:37:21 +00:00
Peter Wemm
7f3dea244c $Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00
Nick Hibma
6dcd4819f1 Add man page for device_quiet and friends 1999-06-22 18:09:54 +00:00
Guy Helmer
2112898830 Document the flags and p parameters to VOP_LOCK and VOP_UNLOCK. Also,
at Doug Rabson's suggestion, add vn_lock(9) as an alternative name for
this manpage and note its calling convention.

PR:		docs/9338
1999-03-17 20:17:32 +00:00
Bruce Evans
ec1b10869b Removed old scsi section 9 man pages. Only cd.9 has been converted to
cam.  scsiconf.9, sd.9, and st.9 can now be found in the Attic.

Reviewed by:	ken
1999-03-06 19:03:31 +00:00
Bruce Evans
2f02d39302 Fixed bitrot in synopsis (devfs_link was renamed to devfs_makelink).
Didn't fix bitrot in this page's name; just install a link.
1999-03-06 17:37:20 +00:00
Nicolas Souchu
88ec80ed82 ppbconf.9 removed 1999-01-30 15:33:20 +00:00
David E. O'Brien
bc6b8d1239 Add MLINKS for devstat kernel interfaces. 1999-01-09 05:09:21 +00:00
Matthew Dillon
88b85f7467 Add manual page describing kernel buffer management system (i.e.
kern/vfs_bio.c).
1998-12-22 19:47:48 +00:00
Matthew Dillon
f44bc94d97 Add manual page for experimental kernel asleep() and await() routines 1998-12-21 10:29:28 +00:00
Nicolas Souchu
fa7bfeb7f9 microseq.9: general purpose parallel microcode for ppbus(4)
ppbconf.9: general info about ppbus(4) structures
1998-10-28 00:55:42 +00:00
Eivind Eklund
c78f3f0d75 Add a manpage for namei().
Markup changes and review by:	dfr
1998-09-27 13:35:49 +00:00
Justin T. Gibbs
fb43a2ea5d Add devstat.9. 1998-09-15 10:26:57 +00:00
Doug Rabson
cefd51ec44 Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00
Peter Dufault
8a6472b723 Finish _POSIX_PRIORITY_SCHEDULING. Needs P1003_1B and
_KPOSIX_PRIORITY_SCHEDULING options to work.  Changes:

Change all "posix4" to "p1003_1b".  Misnamed files are left
as "posix4" until I'm told if I can simply delete them and add
new ones;

Add _POSIX_PRIORITY_SCHEDULING system calls for FreeBSD and Linux;

Add man pages for _POSIX_PRIORITY_SCHEDULING system calls;

Add options to LINT;

Minor fixes to P1003_1B code during testing.
1998-03-28 11:51:01 +00:00
Peter Dufault
917e476dad Reviewed by: msmith, bde long ago
POSIX.4 headers and sysctl variables.  Nothing should change
unless POSIX4 is defined or _POSIX_VERSION is set to 199309.
1998-03-04 10:27:00 +00:00
Bruce Evans
9d44ece512 Removed references to the man pages for the obsolete interfaces
VOP_BLKATOFF, VOP_SEEK, VOP_SELECT, VOP_TRUNCATE, VOP_UPDATE,
VOP_VALLOC and VOP_VFREE.
1998-01-16 18:49:42 +00:00
Bruce Evans
fc372b5422 Sorted lists. Use the same style as most Makefiles for `MLINKS+=' lines. 1998-01-01 10:12:14 +00:00
Bruce Evans
3cfd401c74 Install devfs_remove_dev.9 and suser.9. 1998-01-01 09:40:21 +00:00
Eivind Eklund
16e1a942f7 Activate the bios.9 manpage.
PR:	4215
1997-08-12 18:24:44 +00:00
Mike Pritchard
db0ed86298 Document wakeup_one(). 1997-04-09 05:39:32 +00:00
Mike Pritchard
88cf6634a5 Add malloc(9) to document the kernel malloc() and free() routines.
Obtained from: NetBSD w/changes to reflect current FreeBSD headers
and diagnostic messages.
1997-03-22 23:50:21 +00:00
Mike Pritchard
c8ff0947c0 Add vslock(9) to document the vslock() and vsunlock() kernel functions.
Obtained from: NetBSD
1997-03-22 22:21:37 +00:00
Mike Pritchard
dad0f56607 Add kernacc(9) that documents the kernacc() and useracc() kernel
functions.

Obtained from: NetBSD (renamed from access.9)
1997-03-22 22:06:07 +00:00
Mike Pritchard
4b2502a3e8 Add physio(9).
Obtained from: NetBSD w/minor FreeBSD changes
1997-03-22 21:31:29 +00:00
Mike Pritchard
b6c4b1903b Add mi_switch.9. It documents the kernel mi_switch() and cpu_switch()
context switching functions.

Obtained from: NetBSD (renamed from ctxsw.9)
1997-03-22 20:59:18 +00:00
Mike Pritchard
ec505e0408 Add resettodr(9).
Obtained from: NetBSD
1997-03-22 20:07:04 +00:00
Mike Pritchard
4035c9100d Add inittodr(9) to document how the system clock is initialized.
Obtained from NetBSD and then modified to reflect how things work
in FreeBSD, along with some minor changes to make a few points
clearer.
1997-03-22 19:46:44 +00:00
Mike Pritchard
de1543a46d Add time(9) to document the kernel time variables. Obtained from
NetBSD and then modified by me to reflect some FreeBSD specific
things and to clarify some other pointed based on some old mail
from Bruce Evans about this man page.
1997-03-22 19:09:31 +00:00
Doug Rabson
fab63cc413 This is the current draft of my filesystem manpages. Some files are
incomplete and some are just placeholders but I wanted to try to get
something at least into 2.2 on the grounds that what I have is a lot
better than nothing.  I also wanted to commit something which documents
the interfaces in 2.2 before I start updating the documentation for 3.0.

This is a definite 2.2 candidate and is also relavent to 2.1 if people
still care about that branch.
1997-03-03 18:01:01 +00:00
Peter Wemm
e25aeca937 Revert $FreeBSD$ back to $Id$ 1997-02-22 13:26:29 +00:00
Mike Pritchard
2f581b2bfa Add boot(9) Obtained from NetBSD w/modifications by me. 1997-02-14 07:06:26 +00:00