Commit Graph

992 Commits

Author SHA1 Message Date
Tony Finch
e19cd0127b Clarify the rule about structure typedefs being discouraged, following
a discussion on src-committers.
2003-11-10 14:32:13 +00:00
Joseph Koshy
b684398248 Cross-reference pgfind(9) and pfind(9) from each others manual pages. 2003-11-08 13:41:22 +00:00
Dag-Erling Smørgrav
96ea7698a2 device_get_name(9) and device_get_nameunit(9) return const char *, not int. 2003-11-06 15:54:32 +00:00
Warner Losh
562fb1a6dd Remove the file 2003-11-05 04:36:44 +00:00
Warner Losh
302662db50 resource_query_string is dead. Kill it. 2003-11-05 04:36:13 +00:00
Brooks Davis
9bf40ede4a Replace the if_name and if_unit members of struct ifnet with new members
if_xname, if_dname, and if_dunit. if_xname is the name of the interface
and if_dname/unit are the driver name and instance.

This change paves the way for interface renaming and enhanced pseudo
device creation and configuration symantics.

Approved By:	re (in principle)
Reviewed By:	njl, imp
Tested On:	i386, amd64, sparc64
Obtained From:	NetBSD (if_xname)
2003-10-31 18:32:15 +00:00
Hiten Pandya
ed7d11555d Mdoc Janitor:
* Use uppercase for .Dt macro arguments.

  * Use 'manual' instead of 'man' for consistency.
2003-10-24 15:42:38 +00:00
Hiten Pandya
1bc8ec4783 Mdoc Janitor:
* Add a forgotten .An macro for 'Jeroen Ruigrok van der Werven'.

Noticed by:	simon@
2003-10-23 14:32:23 +00:00
Hiten Pandya
09356c8484 Mdoc Janitor:
* Use 'manual' instead of 'man' for consistency.
2003-10-23 06:24:55 +00:00
Hiten Pandya
b9af5c1881 Mdoc Janitor:
* Uppercase the .Dt command contents.

  * Remove incorrect usage of .Fa.

  * Use .Va for struct members, and .Vt for structs
    (correct replacement for .Fa)

  * Markup VM_* and MAP_* macros with .Dv command.

  * Replace 'man' with 'manual' for consistency.
2003-10-23 06:06:33 +00:00
Hiten Pandya
2f6e000a7e Correct #include file in SYNOPSIS:
It is not sys/geom_disk.h, but located under geom/ directory,
    so, mark it geom/geom_disk.h.
2003-10-23 05:47:38 +00:00
Hiten Pandya
aad6efcc96 Mdoc Janitor:
* Uppercase .Dt command contents.

  * Make use of .Fo and .Fc for marking up functions with
    a lot of arguments.

    NOTE: Please do not use the `\' line seperator for mdoc(7)
    manual pages, as it has problems of its own on some displays;
    instead, consult the mdoc(7) manual on using .Fo and .Fc.

  * Change 'man' to 'manual' for consistency.
2003-10-23 05:41:05 +00:00
Hiten Pandya
b02f4e9071 Mdoc Janitor:
* Use the .Sx command for referencing sections.
2003-10-23 05:34:13 +00:00
Hiten Pandya
8d8abf463c Mdoc Janitor:
* Add .Vt in the right places, transform some .Fa to .Vt, depending
    on discussion context.

  * When refering to the function malloc(), use .Fn, and not .Xr.

  * Add `The' to prefix a sentence when describing a function, so
    it results in ``The xxx() function..."

  * Use `system call' instead of `syscall'.

  * Improve the sentence which discusses accept_filt_generic_mod_event();
    Talk about moduledata_t, and refer to the DECLARE_MODULE(9) manual
    page.

  * Properly markup .An (Author Name) throughout the AUTHORS section.
2003-10-23 05:01:30 +00:00
Hiten Pandya
2cb869e075 Mdoc Janitor:
* Make use of .Xr for vput() and vrele() functions.

  * Reword (s/man/manual) in AUTHORS section.
2003-10-23 03:52:07 +00:00
Hiten Pandya
7c3e994d60 Mdoc Janitor:
* Remove first person sentence start.

  * Make use of .Dv for LEASE_READ and LEASE_WRITE.

  * Move the LOCKS section below the standard mdoc(7) RETURN VALUES
    section.

  * Cleanup grammar for RETURN VALUES and AUTHORS section.

  * Remove redundant sentence on return values.
2003-10-23 03:14:21 +00:00
Hiten Pandya
ed06180abe Mdoc Janitor:
* Make use of .Sq mdoc command.

  * Add a .Pp for separating VOP_RECLAIM text from VOP_INACTIVE

  * Make use of .Fa for the vnode pointer function arg.
2003-10-23 03:07:56 +00:00
Hiten Pandya
559eb8d2e3 Mdoc Janitor:
* Fix hard sentence breaks.
2003-10-23 02:33:03 +00:00
Hiten Pandya
3a858f3798 Mdoc Janitor:
* Fix hard sentence breaks.
2003-10-23 02:22:07 +00:00
Hiten Pandya
4c7b4d14a2 Mdoc Janitor:
* Fix hard sentence breaks.
2003-10-23 02:15:46 +00:00
Hiten Pandya
c1c03d4944 Mdoc Janitor:
* Fix hard sentence breaks in VFS_*(9) and VOP_*(9) manual pages.
2003-10-23 02:11:14 +00:00
Hiten Pandya
a0942a6000 Mdoc Janitor:
* Fix hard sentence breaks.

  * NOTE: devstat(9) requires more mdoc(7) work.
2003-10-23 01:54:06 +00:00
Hiten Pandya
cd367b32ed Mdoc Janitor:
* Fix hard sentence breaks.

  * Correct use of a period in DELAY(9).
2003-10-23 01:31:25 +00:00
Hiten Pandya
ce91e62bc6 Mdoc Janitor:
* Fix hard sentence breaks.
2003-10-23 01:14:18 +00:00
Hiten Pandya
c7d3a65d43 Mdoc Janitor:
* Remove hard sentence breaks from last commit to this file.
2003-10-23 01:08:38 +00:00
Hiten Pandya
e229cfa536 Fix the include path of rijndael.h.
PR:		docs/58437
Submitted by:	Joachim Strombergson
2003-10-22 10:00:09 +00:00
Bruce Evans
e8b6bb6f87 1. Catch up with the move of the declaration of panic() from <sys/param.h>
back to <sys/systm.h>.
2. Remove hard sentence breaks.

Reminded by:	Stefan Farfeleder <stefan@fafoe.narf.at> (1)
2003-10-17 06:25:37 +00:00
Bruce M Simpson
0734ae29f1 Update cross-references. 2003-10-06 01:50:37 +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
fdd1597b47 Use the term 'physical memory' consistently. 2003-10-05 11:47:51 +00:00
Bruce M Simpson
6bcda17f48 Update the page_req classes VM_ALLOC_NOOBJ and VM_ALLOC_ZERO.
Suggested by:	alc
2003-10-05 01:31:51 +00:00
Bruce M Simpson
b0b35125f0 Remove the pmap_prefault(9) page as it is no longer required. 2003-10-04 01:32:25 +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
Warner Losh
6e8666a5a8 Looks like I misread the callout code. We do not seem to hold the
callout lock while the callout is happening.  So the serialization
that I thought was happening isn't.  Therefore, remove the part of the
bugs that says this.  Leave in the other bug as it is very hard to
work around (impossible?).

Fix various typos.

Also note that timeout/untimeout are considered to be the old interface and
the callout interface should be used insetad.

Submitted by: bde (first two) and wollman (third)
2003-10-01 21:32:42 +00:00
Warner Losh
de78273e9c Document the implications of the callout_stop() returning 0 if the
callout has finished or is in progress.  Also document that the
locking of the callout code for FreeBSD 5 has eliminated the 'or is in
progress' clause as a possibility and that such elimination is an
accident of the implementation and shouldn't be relied upon.
2003-10-01 05:48:48 +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
274302ba7a Add a (somewhat verbose) manual page for vm_map(9).
Reviewed by:	juli
Approved by:	jake (mentor)
2003-09-30 00:54:06 +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
Garrett Wollman
43b5281bad Having had to spend several hours today figuring out just what it is that
VOP_GETPAGES() is supposed to do, share the results with everyone who isn't
Alan Cox.
2003-09-28 03:15:21 +00:00
Warner Losh
3c29b8c1c8 Two minor fixes:
o It is the /usr/include files, not the /usr include files.
o Document the practice of converting to the c99 standard uintXX_t
  form from the older, but non-standard, BSD-style u_intXX_t.  This
  has been going on in the tree for a while now, and I've heard other
  developers also state that this conversion is happening.  Note also
  that this is a slow process and should be treated like whitespace
  changes.
2003-09-27 22:17:37 +00:00
Robert Watson
5e50629b39 Additional information on the memory properties of struct disk
instances: the memory holding a struct disk should be pre-zeroed so
as to initialize any storage framework private data in the structures
properly.  In addition, the memory must be writable so that the
private data may be updated.

Pointed out by:	phk
2003-09-26 22:08:23 +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
Sam Leffler
89a688272a update to reflect new api
Submitted by:	Max Laier <max@love2party.net>
Obtained from:	NetBSD (with changes)
2003-09-25 20:49:28 +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
Marcel Moolenaar
4166dd7a7b Add a manpage for BUS_CONFIG_INTR.
Reminded by: eivind
2003-09-24 05:17:06 +00:00
Ruslan Ermilov
959d6c24f6 Get rid of duplicates. 2003-09-14 13:41:59 +00:00
Ruslan Ermilov
a1de21c12e mdoc(7): Fix common mistakes made in the SEE ALSO section. 2003-09-12 21:54:11 +00:00
Hiten Pandya
8fb2b56541 Remove double usage of performance, and combine it to one. 2003-09-12 19:20:05 +00:00