svn commit: r303801 - head/share/man/man3

[Benjamin Kaduk]

Indeed; it seems I was not checking what I thought I was checking in
sys/queue.h; fix incoming.

-Ben

On Sat, 6 Aug 2016, Conrad Meyer wrote:

> Hey Benjamin,
>
> The submitter notes that this wider change isn't quite right in
> https://reviews.freebsd.org/D7428 — LIST_SWAP and TAILQ_SWAP both need
> the "entry" parameter.
>
> Best,
> Conrad
>
> On Sat, Aug 6, 2016 at 10:27 AM, Benjamin Kaduk <bjk at freebsd.org> wrote:
> > Author: bjk (doc committer)
> > Date: Sat Aug  6 17:27:07 2016
> > New Revision: 303801
> > URL: https://svnweb.freebsd.org/changeset/base/303801
> >
> > Log:
> >   Correct the documentation of the 'type' parameter for the _SWAP
> >   macros from sys/queue.h
> >
> >   Submitted by: akshay1994.leo_gmail.com (for STAILQ)
> >   Differential Revision:        https://reviews.freebsd.org/D7428
> >
> > Modified:
> >   head/share/man/man3/queue.3
> >
> > Modified: head/share/man/man3/queue.3
> > ==============================================================================
> > --- head/share/man/man3/queue.3 Sat Aug  6 17:24:35 2016        (r303800)
> > +++ head/share/man/man3/queue.3 Sat Aug  6 17:27:07 2016        (r303801)
> > @@ -141,7 +141,7 @@ lists and tail queues
> >  .Fn SLIST_REMOVE "SLIST_HEAD *head" "TYPE *elm" "TYPE" "SLIST_ENTRY NAME"
> >  .Fn SLIST_REMOVE_AFTER "TYPE *elm" "SLIST_ENTRY NAME"
> >  .Fn SLIST_REMOVE_HEAD "SLIST_HEAD *head" "SLIST_ENTRY NAME"
> > -.Fn SLIST_SWAP "SLIST_HEAD *head1" "SLIST_HEAD *head2" "SLIST_ENTRY NAME"
> > +.Fn SLIST_SWAP "SLIST_HEAD *head1" "SLIST_HEAD *head2" "TYPE"
> >  .\"
> >  .Fn STAILQ_CLASS_ENTRY "CLASSTYPE"
> >  .Fn STAILQ_CLASS_HEAD "HEADNAME" "CLASSTYPE"
> > @@ -164,7 +164,7 @@ lists and tail queues
> >  .Fn STAILQ_REMOVE "STAILQ_HEAD *head" "TYPE *elm" "TYPE" "STAILQ_ENTRY NAME"
> >  .Fn STAILQ_REMOVE_AFTER "STAILQ_HEAD *head" "TYPE *elm" "STAILQ_ENTRY NAME"
> >  .Fn STAILQ_REMOVE_HEAD "STAILQ_HEAD *head" "STAILQ_ENTRY NAME"
> > -.Fn STAILQ_SWAP "STAILQ_HEAD *head1" "STAILQ_HEAD *head2" "STAILQ_ENTRY NAME"
> > +.Fn STAILQ_SWAP "STAILQ_HEAD *head1" "STAILQ_HEAD *head2" "TYPE"
> >  .\"
> >  .Fn LIST_CLASS_ENTRY "CLASSTYPE"
> >  .Fn LIST_CLASS_HEAD "HEADNAME" "CLASSTYPE"
> > @@ -184,7 +184,7 @@ lists and tail queues
> >  .Fn LIST_NEXT "TYPE *elm" "LIST_ENTRY NAME"
> >  .Fn LIST_PREV "TYPE *elm" "LIST_HEAD *head" "TYPE" "LIST_ENTRY NAME"
> >  .Fn LIST_REMOVE "TYPE *elm" "LIST_ENTRY NAME"
> > -.Fn LIST_SWAP "LIST_HEAD *head1" "LIST_HEAD *head2" "TYPE" "LIST_ENTRY NAME"
> > +.Fn LIST_SWAP "LIST_HEAD *head1" "LIST_HEAD *head2" "TYPE"
> >  .\"
> >  .Fn TAILQ_CLASS_ENTRY "CLASSTYPE"
> >  .Fn TAILQ_CLASS_HEAD "HEADNAME" "CLASSTYPE"
> > @@ -211,7 +211,7 @@ lists and tail queues
> >  .Fn TAILQ_NEXT "TYPE *elm" "TAILQ_ENTRY NAME"
> >  .Fn TAILQ_PREV "TYPE *elm" "HEADNAME" "TAILQ_ENTRY NAME"
> >  .Fn TAILQ_REMOVE "TAILQ_HEAD *head" "TYPE *elm" "TAILQ_ENTRY NAME"
> > -.Fn TAILQ_SWAP "TAILQ_HEAD *head1" "TAILQ_HEAD *head2" "TYPE" "TAILQ_ENTRY NAME"
> > +.Fn TAILQ_SWAP "TAILQ_HEAD *head1" "TAILQ_HEAD *head2" "TYPE"
> >  .\"
> >  .Sh DESCRIPTION
> >  These macros define and operate on four types of data structures which
> >
>