CVS log for src/share/man/man3/queue.3

Up to [cvs.NetBSD.org] / src / share / man / man3

Request diff between arbitrary revisions

Keyword substitution: kv
Default branch: MAIN

Remove the CIRCLEQ API from queue(3)

It was marked deprecated in NetBSD 7 and already removed from
FreeBSD in 2000 and OpenBSD in 2015.

Proposed on tech-kern@.

Pull up following revision(s) (requested by sevan in ticket #1351):

	share/man/man4/man4.amiga/grf.4: revision 1.7
	share/man/man4/si.4: revision 1.11
	share/man/man8/man8.sparc/boot.8: revision 1.32
	share/man/man5/nsswitch.conf.5: revision 1.29
	share/man/man5/mixerctl.conf.5: revision 1.7
	share/man/man8/man8.vax/boot.8: revision 1.14
	share/man/man4/man4.vax/dn.4: revision 1.12
	share/man/man8/man8.vax/drtest.8: revision 1.16
	share/man/man8/sysinst.8: revision 1.6
	share/man/man4/ip.4: revision 1.37
	share/man/man5/boot.cfg.5: revision 1.28
	share/man/man1/cd.1: revision 1.10
	share/man/man4/usb.4: revision 1.106
	share/man/man4/man4.vax/ix.4: revision 1.17
	share/man/man7/security.7: revision 1.15
	share/man/man7/hier.7: revision 1.123
	share/man/man8/afterboot.8: revision 1.58
	share/man/man1/man1.x68k/bellctrl.1: revision 1.14
	share/man/man4/se.4: revision 1.6
	share/man/man4/utoppy.4: revision 1.7
	share/man/man4/midi.4: revision 1.32
	share/man/man4/cfb.4: revision 1.5
	share/man/man4/man4.sparc/magma.4: revision 1.12
	share/man/man4/audio.4: revision 1.80
	share/man/man4/isic.4: revision 1.18
	share/man/man1/cd.1: revision 1.7
	share/man/man4/envsys.4: revision 1.51
	share/man/man1/cd.1: revision 1.8
	share/man/man1/cd.1: revision 1.9
	share/man/man3/fast_divide32.3: revision 1.9
	share/man/man4/pci.4: revision 1.97
	share/man/man5/ranlib.5: revision 1.7
	share/man/man3/__arraycount.3: revision 1.7
	share/man/man4/isa.4: revision 1.46
	share/man/man8/man8.atari/ahdilabel.8: revision 1.14
	share/man/man4/chipsfb.4: revision 1.6
	share/man/man8/man8.macppc/boot.8: revision 1.8
	share/man/man5/passwd.5: revision 1.33
	share/man/man8/man8.macppc/ofwboot.8: revision 1.14
	share/man/man8/compat_linux.8: revision 1.38
	share/man/man4/iop.4: revision 1.22
	share/man/man4/ddb.4: revision 1.167
	share/man/man4/termios.4: revision 1.37
	share/man/man8/compat_freebsd.8: revision 1.18
	share/man/man5/ar.5: revision 1.9
	share/man/man7/release.7: revision 1.37
	share/man/man5/core.5: revision 1.31
	share/man/man4/ahd.4: revision 1.6
	share/man/man4/man4.vax/ad.4: revision 1.12
	share/man/man4/pppoe.4: revision 1.39
	share/man/man5/locale.alias.5: revision 1.3
	share/man/man8/man8.amiga/installboot.8: revision 1.23
	share/man/man4/etherip.4: revision 1.8
	share/man/man3/queue.3: revision 1.57
	share/man/man5/genassym.cf.5: revision 1.13
	share/man/man4/mpls.4: revision 1.10
	share/man/man1/wait.1: revision 1.5
	share/man/man5/capfile.5: revision 1.4
	share/man/man4/man4.alpha/ttwopci.4: revision 1.6
	share/man/man4/man4.atari/rtc.4: revision 1.8
	share/man/man4/gpiosim.4: revision 1.6
	share/man/man3/bitstring.3: revision 1.18
	share/man/man4/isdntel.4: revision 1.8
	share/man/man4/ai.4: revision 1.9
	share/man/man8/man8.hppa/boot.8: revision 1.2
	share/man/man4/uyurex.4: revision 1.6
	share/man/man8/man8.alpha/mkbootimage.8: revision 1.9
	share/man/man4/bpf.4: revision 1.56
	share/man/man4/man4.amiga/mfcs.4: revision 1.8
	share/man/man4/cmpci.4: revision 1.9
	share/man/man8/man8.vax/format.8: revision 1.14
	share/man/man8/compat_svr4.8: revision 1.27
	share/man/man4/crypto.4: revision 1.26
	share/man/man4/userconf.4: revision 1.13
	share/man/man4/agp.4: revision 1.17
	share/man/man9/man9.i386/bioscall.9: revision 1.10
	share/man/man4/uftdi.4: revision 1.20
	share/man/man4/radio.4: revision 1.13
	share/man/man4/mfb.4: revision 1.5
	share/man/man7/ascii.7: revision 1.8
	share/man/man4/man4.vax/dl.4: revision 1.13
	share/man/man4/ral.4: revision 1.12
	share/man/man4/unix.4: revision 1.26
	share/man/man4/edc.4: revision 1.12
	share/man/man4/pim.4: revision 1.5
	share/man/man8/compat_ultrix.8: revision 1.21
	share/man/man4/dge.4: revision 1.11
	share/man/man8/diskless.8: revision 1.32
	share/man/man5/passwd.conf.5: revision 1.11
	share/man/man8/man8.acorn26/boot26.8: revision 1.8
	share/man/man4/man4.vax/hy.4: revision 1.12
	share/man/man4/plip.4: revision 1.4
	share/man/man4/sc.4: revision 1.8
	share/man/man4/ec.4: revision 1.14
	share/man/man4/man4.sgimips/giopci.4: revision 1.9
	share/man/man7/sysctl.7: revision 1.114
	share/man/man3/bits.3: revision 1.18
	share/man/man4/we.4: revision 1.19
	share/man/man8/compat_sunos.8: revision 1.21
	share/man/man4/ip6.4: revision 1.31
	share/man/man4/acpilid.4: revision 1.8
	share/man/man4/man4.dreamcast/aica.4: revision 1.6
	share/man/man4/mfi.4: revision 1.12
	share/man/man4/ugen.4: revision 1.32
	share/man/man4/jme.4: revision 1.7
	share/man/man4/man4.sparc64/intro.4: revision 1.5
	share/man/man4/zyd.4: revision 1.5
	share/man/man4/gre.4: revision 1.45
	share/man/man3/bitmap.3: revision 1.10
	share/man/man4/man4.vax/cons.4: revision 1.12
	share/man/man3/gcq.3: revision 1.4
	share/man/man4/man4.hppa/pdc.4: revision 1.3
	share/man/man4/multicast.4: revision 1.8
	share/man/man4/man4.sparc/intro.4: revision 1.27
	share/man/man4/ath.4: revision 1.32
	share/man/man4/ym.4: revision 1.19
	share/man/man3/iso646.3: revision 1.6
	share/man/man4/btsco.4: revision 1.13
	share/man/man4/man4.i386/ndis.4: revision 1.6
	share/man/man4/pad.4: revision 1.6
	share/man/man4/strip.4: revision 1.16
	share/man/man8/man8.x86/boot.8: revision 1.12
	share/man/man4/amr.4: revision 1.15
	share/man/man4/ieee80211.4: revision 1.5
	share/man/man4/options.4: revision 1.467
	share/man/man5/link.5: revision 1.24
	share/man/man8/man8.cobalt/boot.8: revision 1.10
	share/man/man5/stab.5: revision 1.15
	share/man/man3/tree.3: revision 1.12
	share/man/man4/route.4: revision 1.31
	share/man/man4/man4.sun3/leds.4: revision 1.13
	share/man/man4/bluetooth.4: revision 1.20
	share/man/man4/man4.i386/pcibios.4: revision 1.19
	share/man/man5/veriexec.5: revision 1.8
	share/man/man7/operator.7: revision 1.12
	share/man/man4/man4.hp300/dcl.4: revision 1.13
	share/man/man4/man4.i386/intro.4: revision 1.31
	share/man/man5/ld.so.conf.5: revision 1.21
	share/man/man8/man8.alpha/boot.8: revision 1.16
	share/man/man4/bio.4: revision 1.13
	share/man/man4/man4.sun2/leds.4: revision 1.10
	share/man/man8/man8.x86/mbr.8: revision 1.4
	share/man/man8/man8.mvme68k/boot.8: revision 1.9
	share/man/man4/man4.alpha/ttwoga.4: revision 1.6
	share/man/man4/ahc.4: revision 1.34

Direct reader to shell documentation generally, rather than csh(1)
specifically.

Mention variables OLDPWD and PWD.

Move the text that explains that cd(1) is a shell built-in to the very
beginning of the description where it can be seen prominently.

Improve formatting.

 -

Remove workaround for ancient HTML generation code.
Use EXIT STATUS and .Ex.

Sync with HEAD

queue.3: deduplicate deduplicate a a word word

Pull up following revision(s) (requested by pgoyette in ticket #296):
	tests/include/sys/t_list.c: revision 1.1
	tests/include/sys/t_list.c: revision 1.2
	tests/include/sys/Makefile: revision 1.13
	share/man/man3/queue.3: revision 1.59
	distrib/sets/lists/debug/mi: revision 1.226
	sys/sys/queue.h: revision 1.71
	distrib/sets/lists/tests/mi: revision 1.764
Fix the LIST_MOVE macro to properly update the back-pointer of the
first entry in the list.

Note that the signature of LIST_MOVE() macro also changes (it grew an
additional argument).  This should not require a kernel version bump
since nothing appears to use LIST_MOVE() other than the recently added
atf test.

Update for new signature for LIST_MOVE()

Add a new minimalistic test for LIST_MOVE to verify that the list's
first entry's prev pointer correctly points to the listhead.
This test will fail until a fix for LIST_MOVE is checked in (soon).

Add new LIST_MOVE test to sets list.

Update recently-added test to adapt to new signature of LIST_MOVE()

add t_list test.

Update for new signature for LIST_MOVE()

s/tail queue/simple queue/ in SIMPLE QUEUES section.

Remove workaround for ancient HTML generation code.

Sync with HEAD

Use Fn instead of Nm to refer the macros in the body of the man page.

Thanks to wiz@ for reviewing.

Remove comma after the last Nm entry.

Sync with HEAD

fix tyop

Remove trailing whitespace.

Correct list of operations to note that SLISTs and SIMPLEQs cannot insert
entries before existing entries.  This can only be done for LISTs and
TAILQs.

Fixes PR kern/50845

Fix layout for comments. Bump date.

Pull up following revision(s) (requested by snj in ticket #293):
	share/man/man3/queue.3: revision 1.50
Fix some grammar and punctuation issues.  Remove a pasto.

Fix some grammar and punctuation issues.  Remove a pasto.

Rebase to HEAD as of a few days ago.

Rebase.

sync with head.

for a reference, the tree before this commit was tagged
as yamt-pagecache-tag8.

this commit was splitted into small chunks to avoid
a limitation of cvs.  ("Protocol error: too many arguments")

Whitespace and punctuation.

Rename LIST_CONCAT() to LIST_MOVE() as that is what it actually does (and
there is no point to implement LIST_CONCAT() which would iterate).  Update
the queue(3) manpage.

Very slightly more consistency in ordering in SYNOPSIS.
Fix a few typos. Remove superfluous Pp.

Sync queue man pages with queue.h.

Remove extra comma.

remove documentation for CIRCLEQ to discourage its use.

Resync to 2012-11-19 00:00:00 UTC

sync with head

Remove a tab character in non-literal context.
While here, replace all sp macros with Pp.

Sync with HEAD.

Third (and last) commit. See http://mail-index.netbsd.org/source-changes/2009/05/13/msg221222.html

Add queue macros SLIST_FOREACH_SAFE, STAILQ_FOREACH_SAFE, STAILQ_LAST,
SIMPLEQ_CONCAT, and SIMPLEQ_LAST.

Remove seperate definitions outside of queue.h.

Do not mark up "and". Bump date for previous.

add a SIMPLEQ_FOREACH_SAFE() macro.

document it, and the TAILQ versions.

Add a NOTE saying that invalid usage leads to undefined behaviour.
Inspired by PR 39684.

Sync with HEAD.

sync with head.

Move TNF licenses to 2 clause form

sync with HEAD

Catch up to netbsd-4.0 release.

Pull up following revision (requested by pooka in ticket #1009):
	share/man/man3/queue.3: revision 1.36
Note that CIRCLEQ_LOOP first appeared in NetBSD 4.0.

Add TAILQ_CONCAT() and STAILQ_CONCAT(), from FreeBSD.

sync with HEAD

Note that CIRCLEQ_LOOP first appeared in NetBSD 4.0.

bump date

Wrath of wizd avoided because of quick tip from Juan RP.

Add table which summarizes operations supported by each queue type.

from Stathis Kamperis in PR misc/36857

document CIRCLEQ_LOOP

* CICRLEQ -> CIRCLEQ in some places (it's much easier to pronounce)
* be more explicit that CIRCLEQ_FOREACH{,_REVERSE) traverse the queue
  exactly once

Fix CIRCLEQ example bug, from Peter A Jonsson.

Reorder macros within a queue type to match queue.h definition order.
Document STAILQ_* as compatibility macros for SIMPLEQ_*.
Document TAILQ_LAST and TAILQ_PREV.

Bump date for pooka.

Note that SLISTs came from FreeBSD to give people an idea that
they're not necessarily a part of 4.4BSD derived implementations.

Move UCB-licensed code from 4-clause to 3-clause licence.

Patches provided by Joel Baker in PR 22309, verified by myself.

Grammar fix, from jmc@openbsd.

Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.

SIMPLEQ rototill:
- implement SIMPLEQ_REMOVE(head, elm, type, field).  whilst it's O(n),
  this mirrors the functionality of SLIST_REMOVE() (the other
  singly-linked list type) and FreeBSD's STAILQ_REMOVE()
- remove the unnecessary elm arg from SIMPLEQ_REMOVE_HEAD().
  this mirrors the functionality of SLIST_REMOVE_HEAD() (the other
  singly-linked list type) and FreeBSD's STAILQ_REMOVE_HEAD()
- remove notes about SIMPLEQ not supporting arbitrary element removal
- use SIMPLEQ_FOREACH() instead of home-grown for loops
- use SIMPLEQ_EMPTY() appropriately
- use SIMPLEQ_*() instead of accessing sqh_first,sqh_last,sqe_next directly
- reorder manual page; be consistent about how the types are listed
- other minor cleanups

correct descriptions of SLIST_REMOVE_HEAD() and SIMPLEQ_REMOVE_HEAD()

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

s/All four/All five/

Drop unneeded empty line.

Typo/whitespace fix.

Fix description of simple queue. misc/12917 by Witold J. Wnuk with an
additional 'of '.

Subst head.cqh_first with CIRCLEQ_FIRST(&head) instead of CIRCLEQ_HEAD.
Pointed out by Tim on icb sometimes ago (iirc).

document the singly-linked list macros brought in last year.  also
document FOREACH_*{,_REVERSE}, to be added to queue.h shortly.

random cleanups and clarifications, mostly from the freebsd queue.3

Sync w/ netbsd-1-5-base.

One more formatting nit.  *sigh*

Update the date.

Fix formatting error.

Document *_EMPTY().

Pull up to last week's -current.

Don't pass so many args to .Nd macro.  It just overflows.

First round of .Os cleanups.  .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages.  Many more to
come.

macroize BSD, NetBSD, FreeBSD and misc cleanup

Document new queue access methods.

4.4BSD-Lite2

PR/4126: Luke Mewburn: queue(3) doesn't document SIMPLEQ_*

Fix broken uses of Dd.  Both the mdoc and mdoc.samples pages agree:
.Dd is supposed to be invoked like:
	.Dd month day, year
e.g. ".Dd January 25, 1989", rather than:
	.Dd "month day, year"
which is what these pages did.

add and document *_HEAD_INITIALIZER macros, which provide structure
initializers which can be used to initialize list/queue heads at
compile time.

Document {LIST,TAILQ}_INSERT_BEFORE().

Document {LIST,TAILQ}_INSERT_BEFORE().

Merged with 4.4lite.
Changed to conform to NetBSD's new RCS Id convention.

imported from 4.4lite

queue.h from 4.4, from Bostic