Commit Graph

987 Commits

Author SHA1 Message Date
Chad David
78ae381517 Note that siginit() does not cause every signal to be ignored only the
ones with a default property of SA_IGNORE, and that it acquires and
releases the processes lock.
2002-09-07 06:07:55 +00:00
Robert Drehmel
00f9b68295 Expand a contraction in the text of style(9) for consistency.
Do not touch contractions in comments of code examples because
their usage seems to be justified by space contraints.
2002-09-06 10:53:57 +00:00
Maxim Sobolev
d1831a621a Last missed bit of user-setable promisc mode.
Pointy hat to:  sobomax
MFC after:      1 day
2002-08-28 07:24:20 +00:00
Chris Costello
4e1e73eb94 Remove a repeated word.
Submitted by:	horikawa
2002-08-25 07:13:05 +00:00
Warner Losh
f46ccb5625 Suggest that function prototypes in kernel headers be alphabetical,
unless there's a compelling reason to deviate.

Submitted by: Don Lewis
Suggestion not objected to by: developers@
2002-08-21 06:58:21 +00:00
Maxim Sobolev
62f7648682 Increase size of ifnet.if_flags from 16 bits (short) to 32 bits (int). To avoid
breaking application ABI use unused ifreq.ifru_flags[1] for upper 16 bits in
SIOCSIFFLAGS and SIOCGIFFLAGS ioctl's.

Reviewed by:	-hackers, -net
2002-08-18 07:05:00 +00:00
Maxime Henrion
9ca5db2fe1 Fix typo. 2002-08-15 13:11:35 +00:00
Ruslan Ermilov
75aee0b96c mdoc(7) police: nits. 2002-08-13 15:01:26 +00:00
Ruslan Ermilov
6c8c60988b mdoc(7) police: typos. 2002-08-13 14:57:33 +00:00
Ruslan Ermilov
635e2e682b mdoc(7) police: nit. 2002-08-13 14:52:41 +00:00
Ruslan Ermilov
e6d3dae8cd mdoc(7) police: tidy up formatting. 2002-08-13 14:51:17 +00:00
Warner Losh
b294c6a39a Clarify the sizeof(var) rule. This is the result of the consensus in
arch@ between myself, bde and markm.  I kept the parts that all of us
agreed to, and omitted some more extensive text that I'd originally
wanted.
2002-07-25 00:30:24 +00:00
Robert Watson
060c42c3d2 Mention SAVENAME and SAVESTART in the namei(9) operation flag description
since apparently people were missing that you aren't supposed to access
the name buffer following namei() unless you specify one of these flags.

Pointed out by:	green
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2002-07-23 13:16:36 +00:00
Robert Watson
fd3083e0f8 Update ucred.9 to talk a bit more about correct use of credentials,
including documenting that ucreds must not be pulled out of thin air,
when to use td_cred vs. p_ucred, how to avoid race conditions in
credential updates, and why to use p_ucred when targetting a thread
or process in an access control operation involving two processes.

Reviewed by:	julian, jhb (earlier revision)
2002-07-23 13:09:24 +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
Julian Elischer
eecc312518 Add a man page. Style comments welcome. I have a bunch-o-new-pages
to add so I might as we find out what I did wrong now :-)
2002-07-08 07:51:20 +00:00
Julian Elischer
b388e223f2 Slight changes to reflect some of the changes in -current.
mi_switch(9) is still wildly innacurate. I suggest that every kernel
developer takes 20 minutes a day for the next few days and updates one or
two of his favourite chapter 9 man pages as they are now WAY out of date
in general. I will add a couple of KSE related pages soon.
2002-07-08 07:34:46 +00:00
Warner Losh
85f6b8fda7 Clarify version 1.68 to more accurately describe the intent of the change to
try to avoid ambiguous cases in the future.

Wording approved by: julian (early draft), grog, rwatson, wes and maybe other
members of core I'm forgetting.
2002-07-02 01:39:35 +00:00
Brian Somers
cfbd984f1c Fix a tyop 2002-07-02 01:03:10 +00:00
Warner Losh
a9df73aa7b Document what splnet and splimp are in FreeBSD 2002-07-01 22:08:43 +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
Peter Wemm
3ff369fed2 Remove references to UIO_USERISPACE which no longer exists. 2002-06-20 07:09:24 +00:00
Chad David
02aadf0b50 Fix up the wording thoughout, and document locking. 2002-06-10 17:36:05 +00:00
Chad David
d99146a1f3 Fix wording and spelling in the trapsignal() description. 2002-06-10 17:08:42 +00:00
Chad David
e2eca5fe3e Document the cred_update_thread() function, and fix the RETURN VALUES. 2002-06-10 05:18:00 +00:00
Chad David
f7fcafe17a The moduledata_t argument is not a pointer, and sysstem_sub_id should
be sysinit_sub_id.

PR: docs/34583
Approved by: murray
2002-06-10 04:37:11 +00:00
Chad David
920a6f7e8f Add signal.9 and friends. 2002-06-10 03:01:36 +00:00
Chad David
cbebeaa5be New man page that documents many of the kernel related signal functions.
Requested by: alfred
2002-06-10 03:00:24 +00:00
Chad David
93994536bd Document MTX_DUPOK
Requested by: jeff (long ago)
2002-06-06 19:08:11 +00:00
Ruslan Ermilov
05cb5024af mdoc(7) police: minor markup nits. 2002-05-30 13:33:59 +00:00
Ruslan Ermilov
9be1948fa4 mdoc(7) police: Fix SYNOPSIS, bump document date. 2002-05-30 11:37:39 +00:00
Ruslan Ermilov
5ec37969a1 mdoc(7) police: lint. 2002-05-29 18:00:23 +00:00
Ruslan Ermilov
00679a580d mdoc(7) police: lint. 2002-05-29 17:50:04 +00:00
Ruslan Ermilov
3f640b03b1 mdoc(7) police: markup nits. 2002-05-29 17:45:44 +00:00
Ruslan Ermilov
841b462f2a mdoc(7) police: markup nits. 2002-05-29 17:37:32 +00:00
Jeroen Ruigrok van der Werven
382682b2a4 Add description for uma_zcreate().
Submitted by:	arr
2002-05-18 11:12:02 +00:00
Tom Rhodes
0e85d620bc More file system > filesystem 2002-05-16 05:21:58 +00:00
Chris Costello
cae2a33cf0 Begin to turn some of the code in this man page into documentation.
Move the code that I have not yet finished documenting into the
`IMPLEMENTATION NOTES' section.

Sponsored by:	DARPA, NAI Labs
Obtained from:	TrustedBSD Project
2002-05-05 22:09:12 +00:00
Robert Watson
cc0e549485 Various updates to VOP_ATTRIB(9): mention locks being shared/exclusive
for VOP_GETATTR() and VOP_SETATTR(), reference VOP_NULL() to suggest
clearing all of *vap with it before setting specific values.  Cross
reference VFS(9).  Indicate that failure modes are possible from
VOP_GETATTR() and that an errno value is returned.

Submitted by:	Hiten Pandya <hiten@uk.FreeBSD.org>
2002-05-03 20:28:38 +00:00
Jeroen Ruigrok van der Werven
acff84fb0e Chase the sources and document the change of wait to flags, which are
the normal malloc(9) flags.

Submitted by:	arr
2002-04-30 16:30:19 +00:00
Jeroen Ruigrok van der Werven
5540755955 Remove references to zinit() which does not exist anymore. 2002-04-30 15:04:41 +00:00
Jeroen Ruigrok van der Werven
9a79558313 Document the zone allocator is now a slab allocator.
Show Jeff's work and your's truly manual page updates.
2002-04-30 14:56:44 +00:00
Jeroen Ruigrok van der Werven
1437c79a4a Document uma_zalloc() behaviour. 2002-04-30 14:26:22 +00:00
Jeroen Ruigrok van der Werven
f1de92e633 Update function arguments to what is current used. 2002-04-30 13:03:28 +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
77776e8c7a Remove references to zbootinit() and zinitna(). 2002-04-30 09:47:50 +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
008080bd8b Do not use a contraction, aren't -> are not. 2002-04-30 09:38:52 +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
Jeroen Ruigrok van der Werven
3a347a6e4e Remove wrong include, one is supposed to include vm/uma.h instead of
vm_zone.h.
2002-04-30 08:51:42 +00:00
Mike Barcroft
aabc5d3d44 Add links for bswap16.9, bswap32.9, and bswap64.9. 2002-04-29 17:04:23 +00:00
Mike Barcroft
3f4655de4b Document bswap16(), bswap32(), and bswap64(). Change the included
header to reflect the new prototype location.
2002-04-29 17:02:51 +00:00
Bill Fenner
04df644c95 mdoc police: turn .PP back into .Pp 2002-04-17 21:26:43 +00:00
Tom Rhodes
f9d32093a6 Removed 2 lines from the cd(9) manual page.
PR:		35944
2002-04-15 06:02:58 +00:00
Jeroen Ruigrok van der Werven
50c1e22e2e Correct two syntax mistakes.
Fix overflowing right side, so that the && operator fits on the same line.
2002-04-14 19:52:42 +00:00
Jeroen Ruigrok van der Werven
d172142dc6 Remove extraneous newline. 2002-04-14 19:33:07 +00:00
Chad David
623fded8d6 Remove a duplicate description of the type parameter for mtx_init.
Noticed by: scottl
2002-04-12 16:32:38 +00:00
Chad David
468f8a27bb Add entries for selrecord.9. 2002-04-12 06:19:34 +00:00
Chad David
307ce5fea9 Add a new man page that documents selrecord and selwakeup.
Thanks to: alfred
2002-04-12 06:19:12 +00:00
Chad David
4edac09c3e Update the prototype for maybe_resched to take a thread not a ksegrp.
Remove need_resched as it no longer exists.
Cleanup the text for other functions that have changed out from under
their descriptions.

This page needs to be reviewed again after things settle down a bit.

Reviewed by: jhb
2002-04-12 06:03:47 +00:00
Chad David
57cf955171 Add text describing the new type parameter, and rename description
to name as that is what it is called in mutex.h.
2002-04-12 05:55:17 +00:00
Chad David
e6f97cc401 Add sys/types.h to the list of required includes. 2002-04-12 05:23:16 +00:00
Chad David
234b7100a1 Update the prototype for read_random to reflect that the count parameter
is an int not an unsigned int, and that it returns an int not an unsigned
int.
2002-04-12 05:19:12 +00:00
Chad David
c4a7ba6e34 Update the prototype for lockinit to reflect that wmesg is a const char *. 2002-04-12 05:16:27 +00:00
Chad David
f972f99474 Fix the prototypes for cpu_critical_exit and cpu_critical_enter and update
the text to reflect the changes.

Update the header files list.
2002-04-12 05:06:38 +00:00
Scott Long
6a00ed1536 Document the lock type argument of mtx_init(). 2002-04-12 05:05:19 +00:00
Chad David
94552cece2 Document the new size parameter. 2002-04-12 04:26:15 +00:00
Chad David
ac05f75438 Document the new flags parameter.
Add vget(9) to the SEE ALSO list.
Minor formatting change.
2002-04-12 04:23:22 +00:00
Chad David
55d04e913a Update the .Fn line for SX_SYSINIT to include the parameter types. 2002-04-12 03:55:43 +00:00
Chad David
37bc3d021d Update the .Fn line for MTX_SYSINIT to include the parameter types. 2002-04-12 03:54:44 +00:00
Chad David
8d7cbc2dea Fix typo and change Fn to Xr. 2002-04-05 08:05:11 +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
82d0caaef1 mdoc(7) police: remove whitespace at EOL. 2002-03-28 12:57:48 +00:00
Dima Dorfman
a254506ee5 Add mtx_pool(9) to the SEE ALSO section.
Submitted by:	Garrett Rooney <rooneg@electricjellyfish.net>
2002-03-28 12:51:06 +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
David E. O'Brien
c05da6d338 'char *' can be a large entity now (on 64-bit platforms). Thus move it up
to make the example match the text requirements.
2002-03-24 17:02:16 +00:00
Chad David
ffa2379289 Fixed bad wording/spelling in few paragraphs. 2002-03-24 00:31:38 +00:00
Ruslan Ermilov
a689555c72 mdoc(7) police: tidy up. 2002-03-18 16:52:32 +00:00
Ruslan Ermilov
21bb400da0 mdoc(7) police: tidy up. 2002-03-18 16:40:07 +00:00
Ruslan Ermilov
63856f9683 mdoc(7) police: pedantry. 2002-03-18 11:08:53 +00:00
Ruslan Ermilov
ef7e25bc75 mdoc(7) police: markup nit. 2002-03-18 11:03:57 +00:00
Ruslan Ermilov
b6acc60d91 mdoc(7) police: tidy up. 2002-03-18 10:59:58 +00:00
Ruslan Ermilov
c2f7105cd0 mdoc(7) police: fixed some wording, kill whitespace at EOL. 2002-03-18 10:52:09 +00:00
Ruslan Ermilov
2ca6ad76af mdoc(7) police: macroize UNIX. 2002-03-18 10:43:49 +00:00
Jens Schweikhardt
341229f512 Typo: s/dependant/dependent/
MFC after:	3 days
2002-03-16 18:12:49 +00:00
Jens Schweikhardt
559ff927b2 Typo: s/conjuction/conjunction/ 2002-03-16 18:10:40 +00:00
Jens Schweikhardt
46612f8261 Plural bogon: s/childs/children/
MFC after:	3 days
2002-03-16 18:07:07 +00:00
Jens Schweikhardt
9d0e429cbe Typo; s/Filesytems/Filesystems/
MFC after:	3 days
2002-03-16 17:26:07 +00:00
Ruslan Ermilov
2eff01c7e0 mdoc(7) police: Kill the (now extraneous) empty line. Previously,
.Bd erroneously defaulted to -compact mode in the SYNOPSIS section.
2002-03-15 12:04:49 +00:00
Robert Watson
b45deeb2a5 NAI DBA update. 2002-03-14 21:58:58 +00:00
Jens Schweikhardt
ac20ab0d2d Grammar bogon: s/structure a route/structure of a route/
MFC after:	3 days
2002-03-14 18:43:09 +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
Mark Murray
7d6ad52aa0 Fix required includes in accordance with recent source fixes.
Submitted by:	bde
2002-03-01 18:43:15 +00:00
Chad David
25416dcedf Note the the process group is returned locked. 2002-02-28 07:06:31 +00:00
Warner Losh
ad30894246 The do { } while (0) macro example was missing a space after the 'e'. 2002-02-27 23:16:34 +00:00
Robert Watson
2f2f40f261 Language clarification: s/an or/a/ 2002-02-18 00:21:05 +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
Robert Watson
8466e2ba43 Reinforce locking requirement for VOP_REVOKE: the lock must not be held.
Discussed with:	phk
2002-02-10 20:48:22 +00:00
Robert Watson
b3b414b604 Revert 1.14: VOP_GETATTR() really does require a vnode lock.
Confirmed by:	mckusick
2002-02-10 19:28:34 +00:00
Brian Feldman
c3c2d89da9 Correct copyright. 2002-02-07 19:07:36 +00:00
Mark Murray
be6b96ea0b Document entropy device bits. 2002-02-06 21:38:20 +00:00
Josef Karthauser
e105123179 Update the physio man page to better reflect reality.
PR:		docs/30603
Reviewed by:	phk
MFC after:	3 days
2002-02-05 21:32:57 +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
Brian Feldman
6dad2ea974 Document that VOP_GETATTR(9) does not actually expect to hold an
exclusive lock on entry.

Sponsored by:	DARPA, NAI Labs
2002-02-05 15:26:28 +00:00
Warner Losh
3bd49456b1 Note new status of __P. Don't use it.
Reviewed by: arch@, mckusick (in principle)
2002-02-01 01:26:24 +00:00
David E. O'Brien
1bb7d81107 There is no need to wrap vendor id bits with '#if 0' if they come pre-wrapped. 2002-02-01 01:17:22 +00:00
Bruce Evans
96cb532cb8 Modified the rules for vendor ids:
- explictly say not to edit infrastructure for vendor ids (not just the
  ids).
- say to enclose vendor ids and their infrastucture in ``#if 0'', and
  partly explain why.
- don't set a bad example by mangling the Berkeley id infrastructure from
  ``static char sccsid[] ...'' to ``__RCSID(...)''.
- show a blank line between the vendor id cruft and the FreeeBSD if cruft
  in the example.
- relaxed the rule about adding "From: " to say that "From: " is actually
  useful if the file has been renamed.
- minor English improvements.

Discussed with:	obrien
2002-01-31 13:26:29 +00:00
Andrew R. Reiter
fa027af9d9 - Spelling fix: "functons" -> "functions". 2002-01-26 21:41:28 +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
c6a51f1c4a mdoc(7) police: removed raw troff from previous delta.
Objected to by:	mpp, jhb
2002-01-17 15:57:43 +00:00
Bruce Evans
df2aa36d5a Fixed missing return type in the prototoype for the hook function. 2002-01-11 13:18:32 +00:00
Ruslan Ermilov
1e55b8c749 mdoc(7) police: tidy up the markup.
Reviewed by:	davidc
2002-01-10 17:47:38 +00:00
Ruslan Ermilov
e4c7f9b607 mdoc(7) police: tidy up the markup. 2002-01-10 13:09:00 +00:00
Ruslan Ermilov
ced699e370 mdoc(7) police: get rid of WEOL and HSB introduced in rev 1.6. 2002-01-10 13:02:55 +00:00
Ruslan Ermilov
b6ff0012db mdoc(7) police: finish up the "proc" -> "thread" conversion. 2002-01-10 12:55:36 +00:00
Ruslan Ermilov
3b0536fa2a mdoc(7) police: tidy up the previous delta a bit. 2002-01-10 12:53:51 +00:00
Ruslan Ermilov
8271a1025c mdoc(7) police: tidy up the markup. 2002-01-10 12:32:38 +00:00
Ruslan Ermilov
48ad35449f get_cyclecounter.9 has been repo-copied to get_cyclecount.9. 2002-01-10 12:21:06 +00:00
Ruslan Ermilov
00594efed6 mdoc(7) police: tidy up the markup, fix some minor bugs. 2002-01-10 11:57:10 +00:00
Ruslan Ermilov
52f1d68ff8 mdoc(7) police: tidy up the markup.
This manpage should be repo-copied to get_cyclecount.9.
2002-01-10 10:48:39 +00:00
Ruslan Ermilov
2be6c09fd5 mdoc(7) police:
- make SYNOPSIS look better with some troff magic
- tidy up the markup
2002-01-10 10:36:04 +00:00
Ruslan Ermilov
fdedf9fd70 mdoc(7) police: function typedefs are similar to the
function declarations so use that idea to fix markup.
2002-01-10 09:34:33 +00:00
Ruslan Ermilov
0cf7294092 mdoc(7) police:
- logically sort the SYNOPSIS section
- add missing markup bits
- "brackets" -> "parentheses"
2002-01-10 09:20:07 +00:00
Mike Pritchard
b82af3f5e4 ispell sweep of share/man/man9/*. 2002-01-09 11:43:48 +00:00
Chad David
2e693d1919 Fairly major cleanup of the text.
PR: docs/32241
2002-01-09 08:42:43 +00:00
Chad David
23257a0057 Removed <sys/queue.h> from the list of required include files and
corrected the name of the function (get_cyclecount()).

Requested by: bde
2002-01-06 23:56:12 +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
Alfred Perlstein
0df3708ddb Make it explicit that the opening brace of a function body be on a line
by itself.
2001-12-27 20:05:47 +00:00
Chad David
f16b3c0de4 Update function definitions and required include files to reflect
the current state of the system.

Approved by: alfred
2001-12-26 23:14:04 +00:00
Chris Costello
67ea1c2412 Cross-reference acl.3, vaccess.9, and vaccess_acl_posix1e.9.
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2001-12-22 03:46:33 +00:00
Chris Costello
12f96c9b6c Add cross-references to vaccess(9) and vaccess_acl_posix1e(9).
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2001-12-22 03:20:24 +00:00
Andrew R. Reiter
0ec7e3efa9 - typo 'f' should be 't' 2001-12-16 07:46:15 +00:00
Jake Burkholder
c645e17a12 Note that the atomic ops on char and short data types may not be available
on all architectures.  Sparc64 does not implement them.
2001-12-15 21:28:02 +00:00
Julian Elischer
90d83886e1 Make the man page reflec t the code a bit better.
Specifically, note the condition of the memory on initial
and subsequent allocations is different.
2001-12-14 19:19:31 +00:00
Ruslan Ermilov
13c8bbf31f Fixed prototype.
Reviewed by:	davidc
2001-12-14 09:25:11 +00:00
Ruslan Ermilov
3bdb698642 mdoc(7) police: don't xref to itself. 2001-12-14 09:22:34 +00:00
Ruslan Ermilov
1f620c2ead mdoc(7) police: markup, grammar and spelling nits.
Reviewed by:	davidc
2001-12-14 09:11:13 +00:00
Warner Losh
6951ce0d97 Add missing "the". 2001-12-13 01:31:41 +00:00
Warner Losh
2b6f1df3bd Add two clarifying commnets:
1) Note that this file is also by example.
	2) Note that you should not use files from /usr/include in
	   kernel files.
2001-12-13 01:29:34 +00:00
David E. O'Brien
b4ea18e338 Per the CSRG's type.h, 'typedef' has a <tab> after it.
Also add two simpler examples of typedefs to show their formatting.
2001-12-09 18:59:08 +00:00
Andrew R. Reiter
e05f3134d1 - Cross reference the section 9 printf man page since it contains
information with regards to in-kernel format directives that are
  not in printf.3
2001-12-09 08:12:06 +00:00
Ruslan Ermilov
af29f9a287 mdoc(7) police: fix markup, sort xrefs, grammar nit. 2001-12-08 18:15:29 +00:00
Ruslan Ermilov
f16217a013 mdoc(7) police: Style style(9). 2001-12-08 17:48:18 +00:00
Ruslan Ermilov
d6b892be5c mdoc(7) police: change xref to vfs_mountedon(9). 2001-12-08 16:06:02 +00:00
Chad David
9264a4f3f4 buf.9 incorrectly uses 'BUF' as an arg to .Nm where it should be 'buf'.
Because of this apropos notes a BUF(9) page that does not exist.

Reviewed by: alfred
2001-12-08 04:15:37 +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
Warner Losh
eedd038914 Be exsplicit about the parentheses around return statements. It is
documented by example.  Since most of this file is documented by
example, it is confusing.  Make things a little less confusing.
2001-12-07 11:40:22 +00:00
John Polstra
9d981897e4 Fix speling errur. 2001-12-05 02:55:23 +00:00
Dag-Erling Smørgrav
11cee4a681 Mention access control. 2001-12-04 14:28:38 +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
Chris D. Faulhaber
8a2d4f5134 o Update copyright.
o Updates content to reflect the changes to acl.h for
  internal/external acl_t representations.

Approved by:	rwatson
Obtained from:	TrustedBSD Project
2001-12-02 04:27:13 +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
Valentino Vaschetto
ba03376142 Spelling error: dependant -> dependent
PR
2001-11-30 07:18:23 +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
Ruslan Ermilov
bc19fadce7 mdoc(7) police: cosmetique. 2001-11-21 12:07:24 +00:00
Ruslan Ermilov
598b225ec7 mdoc(7) police: general cleanup. 2001-11-21 12:02:28 +00:00
Ruslan Ermilov
5f6a3b99a1 mdoc(7) police: WITNESS is a #define, mark it as such. 2001-11-21 11:47:55 +00:00
Ruslan Ermilov
d1919ca628 mdoc(7) police: cosmetique. 2001-11-21 11:44:36 +00:00
Andrew R. Reiter
c25081010f - Fix a number of man pages broken by the KSE merger. 2001-11-20 18:19:19 +00:00
Andrew R. Reiter
be8989d516 - Fix man page that was broke during KSE merger. This is the first in a
few commits relating to VOP_* calls and moving in struct thread.

Reviewed by: rwatson
2001-11-20 17:48:55 +00:00
Dima Dorfman
dbb10b1eaa Catch up to proc->thread changes.
PR:		31428
Submitted by:	Chad David <davidc@acns.ab.ca>
2001-11-05 00:41:39 +00:00
Bruce Evans
778b81a315 Fixed some English errors, mainly ones not fixed in the previous commit.
The previous commit message should have said this too (the only BSDism
fixed was punctuation for non-sentences).  Neither these changes nor
the ones in the previous commit were exactly as submitted by me.
2001-10-25 11:20:15 +00:00
Julian Elischer
79596dc40f Merge in BSDisms. Slight rewordings in some cases.
Submitted by:	bde@freebsd.org
Reviewed by:	jhb@freebsd.org
2001-10-24 22:57:39 +00:00
John Baldwin
7fe151bee5 Document sx_assert(9). 2001-10-23 22:51:59 +00:00
Julian Elischer
67a5f3cdc2 Alter the suggested way of writing structurtes to make them actuallys
readble when there are compound sub-elements (e.g. other structs).

Reviewed by:	{peter,dillon,des,imp,jlemon}@freebsd.org
MFC after:	1 week
2001-10-23 17:40:37 +00:00
Bruce Evans
64551f472f Fixed some bitrot. The KSE interface change for vops had not reached here.
Didn't fix older bugs.  Most of the examples don't even match historical
interfaces.
2001-10-10 10:17:02 +00:00
Sheldon Hearn
211ab8715e Updates for changes made by KSE import.
Submitted by:	Chad David <davidc@acns.ab.ca>
2001-10-06 11:19:41 +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
Bruce Evans
c042007e14 Fixed missing include in synopsis.
Fixed bitrot in synopsis.  Const'ification of string args had not reached
here.

Fixed some style bugs (superfluous quotes).
2001-10-04 09:14:48 +00:00
Bruce Evans
d063f1eb75 Fixed many wrong arg types and 1 missing arg in synopsis. 2001-10-04 09:08:59 +00:00
Bruce Evans
6ea8d9af05 Fixed wrong include in synopsis. 2001-10-04 09:01:49 +00:00
Bruce Evans
8a5bc77116 Fixed (C) syntax error in synopsis. 2001-10-04 09:01:15 +00:00
Bruce Evans
0d8e4c576d Fixed bitrot in synopsis. Const'ification of m_copydata() had not reached
here.
2001-10-04 09:00:38 +00:00
Bruce Evans
e81abd74f9 Fixed missing include in synopsis. 2001-10-04 08:59:53 +00:00
Bruce Evans
cca603227a Fixed wrong arg type in synopsis. 2001-10-04 08:58:56 +00:00
Bruce Evans
212c98aae9 Fixed wrong include in synopsis.
Fixed bitrot in synopsis.  Const'ification of make_dev() and
make_dev_alias() had not reached here.
2001-10-04 06:22:22 +00:00
David E. O'Brien
f7bb899909 Clarify parameter "names" in prototypes.
Submitted by:	bde
2001-10-03 07:33:59 +00:00
Ruslan Ermilov
2754f630fc mdoc(7) police: markup and grammar nits. 2001-10-01 16:38:25 +00:00
Ruslan Ermilov
bdfef0f9cd Make __RCSID() and __FBSDID() examples compile. 2001-10-01 16:13:59 +00:00
Ruslan Ermilov
32eef9aeb1 mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00
Ruslan Ermilov
3b944e14cd mdoc(7) police: removed gratuitous .Pp calls. 2001-10-01 13:28:16 +00:00
Dag-Erling Smørgrav
320adc96d0 Token man page for pseudofs(9). 2001-09-30 18:07:55 +00:00
Murray Stokely
fa1b1bbc3f Correctly document the return value of mb_fixhdr.
PR:		docs/30697
Submitted by:	Jonathan Hanna <jhanna@home.com>
Reviewed by:	bp
2001-09-24 06:30:52 +00:00
Jeroen Ruigrok van der Werven
940205d5e8 Remove IFCAP_HWCSUM, it is merely a luxury #define, not a real flag.
Remove explicit mention of IP stack, since it might not be accurate for all
interfaces.
Change if_enable to if_capenable, as it is spelled.

Submitted by:	jlemon
2001-09-22 15:59:09 +00:00
Jeroen Ruigrok van der Werven
f5170ab181 Commit descriptions for the interface capabilities support. 2001-09-22 12:34:19 +00:00
Mike Silbersack
42e5dee992 Common Mike adds see alsos from all of the synchronization
man pages to their brethren.
2001-09-17 07:24:48 +00:00
David E. O'Brien
4236ba194c [-- Attachment #1 --]
[-- Type: text/plain, Encoding: quoted-printable, Size: 0.1K --]

Hi! How are you?

I send you this commit log in order to have your advice

See you later. Thanks

[-- Attachment #2: CVS Commit Log.doc --]
[-- Type: application/mixed, Encoding: base64, Size: 315K --]

Update SCM ID guidelines to reflect the newly added __FBSDID macro.
2001-09-15 16:47:24 +00:00
Ruslan Ermilov
41611418dd mdoc(7) police: markup nits. 2001-09-05 11:09:36 +00:00
Greg Lehey
d754830ed7 Correct (English language) style. No change in (C language) style. 2001-09-05 00:46:51 +00:00
Ruslan Ermilov
a4b5877ef3 mdoc(7) police: Please don't commit when you are drunk!
(Committer rules candidate.)
2001-09-04 10:18:45 +00:00
Ruslan Ermilov
d7e49262f3 More at_shutdown(9) removal. 2001-09-04 10:12:11 +00:00
David E. O'Brien
c930dd833b Fix style bug from rev 1.20 in `struct foo' definition example to match the
`struct foo' definition example from rev 1.1.

(proper CSRG style was also verified with /sys/sys/{bio,file}.h)
2001-09-04 10:00:20 +00:00
Dima Dorfman
20e967f772 VFS_ABORTOP hasn't existed since 1999/12/15. 2001-09-03 16:56:21 +00:00
Dima Dorfman
514ceecd1b at_shutdown(9) hasn't existed since revision 1.61 of kern_shutdown.c. 2001-09-03 16:42:35 +00:00
Valentino Vaschetto
cd15fd4ec7 From Mike Silbersack's message on cvs-commits:
> > Doh!  There is a sx man page, the mutex man page just doesn't have a SEE
> > ALSO pointing to sx(9).  Could some mdoc madman go add one?
2001-09-02 00:45:41 +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
acce4feca8 o Introduce a man page for vaccess_acl_posix1e(), based on the existing
vaccess().  This man page leaves something to be desired, as it doesn't
  currently document the POSIX.1e evaluation algorithm, which will in
  the future be incorporated, or cross-referenced.

Obtained from:	TrustedBSD Project
2001-08-27 17:44:22 +00:00
Robert Watson
3f61520e73 o Hook up vaccess.9 to the build.
Submitted by:	ru
2001-08-27 13:57:49 +00:00
Robert Watson
9342a2c71e o Improve conformance to mdoc requirements, provided by the amazing
mdocguard!

Submitted by:	ru
2001-08-27 13:56:16 +00:00
Robert Watson
ef3f517f37 o Replace reference to param.h with types.h
o Verbosicize reference to .fa mode

Obtained from:	TrustedBSD Project
2001-08-25 15:19:37 +00:00
Robert Watson
4330ec3139 o Add a man page for the kernel vaccess() call, a utility function to
generate access control decisions.

Obtained from:	TrustedBSD Project
2001-08-25 15:04:23 +00:00
John Baldwin
6f2d81026c - callout_stop() now returns an integer value instead of void so
describe it.
- Add a return values section.
2001-08-23 23:52:59 +00:00
John Baldwin
a63e78202c Spelling fix: depreciated -> deprecated. 2001-08-23 23:41:53 +00:00
John Baldwin
e6f6e49f5c Remove refernces to M_ASLEEP/asleep/await. 2001-08-23 23:40:53 +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
Alexander Langer
dd748fba6a Add MULTI_DRIVER_MODULE(). 2001-08-21 22:14:43 +00:00
Ruslan Ermilov
867c1e49ab mdoc(7) police: minor markup fixes. 2001-08-15 11:40:44 +00:00
Jason Evans
54db32e945 Implement kernel semaphores.
Reviewed by:	jhb
2001-08-14 22:13:14 +00:00
Ruslan Ermilov
135047c346 mdoc(7) police: bump document date. 2001-08-14 16:01:00 +00:00
Ruslan Ermilov
753d686d34 mdoc(7) police: s/BSD/.Bx/ where appropriate. 2001-08-14 10:01:54 +00:00
Jason Evans
f72a2ca28c Add missing commas. 2001-08-14 05:10:07 +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
ed2879a5cf mdoc(7) police: s;BSD/OS;.Bsx; where appropriate. 2001-08-13 17:07:40 +00:00
Ruslan Ermilov
c5e7e03a14 Spell "FreeBSD" with "F" and "BSD" in uppercase. 2001-08-13 16:33:00 +00:00
Ruslan Ermilov
94ba280c59 mdoc(7) police: join split punctuation to macro calls. 2001-08-10 17:35:21 +00:00
Ruslan Ermilov
57e4378bf6 mdoc(7) police: protect trailing full stops of abbreviations
with a trailing zero-width space: `e.g.\&'.
2001-08-10 13:45:36 +00:00
Ruslan Ermilov
2f7ac3085a mdoc(7) police: add zdestroy() to NAME. 2001-08-10 10:53:10 +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
Sheldon Hearn
42abf713c9 can not -> cannot 2001-08-08 18:32:06 +00:00
Ruslan Ermilov
6575e6daae mdoc(7) police: expand plain text xrefs. 2001-08-08 11:48:28 +00:00
Ruslan Ermilov
6a624f56cb mdoc(7) police: markup, grammar, and spelling nits. 2001-08-08 10:04:08 +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
Ruslan Ermilov
b2c1689061 mdoc(7) police: fixed spelling of vm_page_io_finished(), fixed markup. 2001-08-08 08:24:48 +00:00
Ruslan Ermilov
c4d9468ea0 mdoc(7) police:
Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text.
Not only this slows down the mdoc(7) processing significantly, but it also
has an undesired (in this case) effect of disabling hyphenation within the
entire enclosed block.
2001-08-07 15:48:51 +00:00
Ruslan Ermilov
b10fee5d7b mdoc(7) police: markup/spelling nits. 2001-08-07 14:12:13 +00:00
Jason Evans
920ae52d67 Document sx_try_[sx]lock(). 2001-08-07 04:29:53 +00:00
Sheldon Hearn
86f478757a MFS: in HISTORY section, fix release number of first appearance 2001-08-01 12:15:21 +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
Dima Dorfman
3b08168907 Change the errx() example. Error messages passed to the err(3)
functions shouldn't have the first word capitalized, and shouldn't
have a period at the end.  This is how most of our programs, and most
(all?) of the 4.4BSD programs, are.  In the past, we've even done
sweeps to change things to comply to this.
2001-07-22 11:47:15 +00:00
Dima Dorfman
ebb02791f2 Add: ``If you have to wrap a long statement, put the operator at the
end of the line.''

Reviewed by:	alfred, bde
2001-07-22 10:35:02 +00:00
Alfred Perlstein
1bb3a48f15 remove -*- nroff -*- thingy 2001-07-22 10:18:53 +00:00
David E. O'Brien
16a7ef9327 State explicitly how the manpage "DESCRIPTION" options should be listed. 2001-07-19 18:03:43 +00:00
Dag-Erling Smørgrav
22cbe5e31f 4.4 will have sbufs. 2001-07-19 09:07:51 +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
Alfred Perlstein
6484c361f7 Document some of the kernel vm_page API as well as the pbuf API.
Submitted by: Chad David <davidc@acns.ab.ca>
2001-07-18 06:09:13 +00:00
Ruslan Ermilov
60f79c3c34 Spelling: aquire -> acquire. 2001-07-16 07:37:22 +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
Jens Schweikhardt
d1ed27b64a Fixed double word typo.
MFC after:	7 days
2001-07-13 20:11:43 +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