s/XXX/FIXME/

This commit is contained in:
Michael Kerrisk 2005-10-26 11:27:52 +00:00
parent f39637fad6
commit a749f870a8
11 changed files with 32 additions and 32 deletions

View File

@ -146,7 +146,7 @@ The
.I flags
parameter is the bitwise OR
of zero or more of the following flags.
.\" XXX document MSG_PROXY
.\" FIXME document MSG_PROXY
.TP
.B MSG_OOB
Sends

View File

@ -6,7 +6,7 @@
netlink \- Netlink macros
.SH SYNOPSIS
.nf
.\" XXX what will glibc 2.1 use here?
.\" FIXME what will glibc 2.1 use here?
.B #include <asm/types.h>
.br
.B #include <linux/netlink.h>
@ -53,7 +53,7 @@ NLMSG_DATA
Return a pointer to the payload associated with the passed
.IR nlmsghdr .
.TP
.\" XXX this is bizarre, maybe the interface should be fixed.
.\" FIXME this is bizarre, maybe the interface should be fixed.
NLMSG_NEXT
Get the next
.I nlmsghdr

View File

@ -76,7 +76,7 @@ returns the amount of space which will be needed in the message with
bytes of data.
.SH EXAMPLE
.\" XXX would be better to use libnetlink here
.\" FIXME would be better to use libnetlink here
Creating a rtnetlink message to set a MTU of a device.
.nf

View File

@ -111,8 +111,8 @@ with a hexadecimal number
.I <escape_char><number>
with an octal number.
.\" XXX - comments
.\" XXX - char ... char
.\" FIXME - comments
.\" FIXME - char ... char
.SH FILES
.I /usr/share/i18n/charmaps/*

View File

@ -105,7 +105,7 @@ wildcard and also implies \(lqthis node.\(rq The value of
.B ATADDR_BCAST
is a link
local broadcast address.
.\" XXX this doesn't make sense [johnl]
.\" FIXME this doesn't make sense [johnl]
.SH "SOCKET OPTIONS"
No protocol-specific socket options are supported.
.SH SYSCTLS
@ -137,7 +137,7 @@ All ioctls described in
.BR socket (7)
apply to ddp.
.\" XXX Add a chapter about multicasting
.\" FIXME Add a chapter about multicasting
.SH NOTES
Be very careful with the
@ -150,8 +150,8 @@ Appletalk is supported by Linux 2.0 or higher. The
interface is
new in Linux 2.2.
.SH ERRORS
.\" XXX document all errors. We should really fix the kernels to give more uniform
.\" error returns (ENOMEM vs ENOBUFS, EPERM vs EACCES etc.)
.\" FIXME document all errors. We should really fix the kernels to give
.\" give more uniform error returns (ENOMEM vs ENOBUFS, EPERM vs EACCES etc.)
.TP
.B ENOTCONN
The operation is only defined on a connected socket, but the socket wasn't

View File

@ -39,7 +39,7 @@ files or with the
.BR sysctl (2)
interface. Most of these sysctls are rate limitations for specific ICMP types.
Linux 2.2 uses a token bucket filter to limit ICMPs.
.\" XXX better description needed
.\" FIXME better description needed
The value is the timeout in jiffies until the token bucket filter is cleared
after a burst. A jiffy is a system dependent unit, usually 10ms on x86 and
about 1ms on alpha and IA64.

View File

@ -30,7 +30,7 @@ described in RFC\ 791 and RFC\ 1122.
contains a level 2
multicasting implementation conforming to RFC\ 1112.
It also contains an IP router including a packet filter.
.\" XXX: has someone verified that 2.1 is really 1812 compliant?
.\" FIXME: has someone verified that 2.1 is really 1812 compliant?
.PP
The programmer's interface is BSD sockets compatible.
For more information on sockets, see
@ -72,7 +72,7 @@ a valid IANA IP protocol defined in
RFC\ 1700
assigned numbers.
.PP
.\" XXX ip current does an autobind in listen, but I'm not sure if that should
.\" FIXME ip current does an autobind in listen, but I'm not sure if that should
.\" be documented.
When a process wants to receive new incoming packets or connections, it
should bind a socket to a local interface address using
@ -257,7 +257,7 @@ struct in_pktinfo {
.fi
.RE
.IP
.\" XXX elaborate on that.
.\" FIXME elaborate on that.
.B ipi_ifindex
is the unique index of the interface the packet was received on.
.B ipi_spec_dst
@ -334,7 +334,7 @@ Linux sends
.B IPTOS_LOWDELAY
datagrams first by default,
but the exact behaviour depends on the configured queueing discipline.
.\" XXX elaborate on this
.\" FIXME elaborate on this
Some high priority levels may require an effective user ID of 0 or the
.B CAP_NET_ADMIN
capability.
@ -464,7 +464,7 @@ When the error originated from the network, all IP options
etc.) enabled on the socket and contained in the
error packet are passed as control messages. The payload of the packet
causing the error is returned as normal payload.
.\" XXX: is it a good idea to document that? It is a dubious feature.
.\" FIXME: is it a good idea to document that? It is a dubious feature.
.\" On
.\" .B SOCK_STREAM
.\" sockets,
@ -546,7 +546,7 @@ take it into account for their packet retransmit strategy.
To bootstrap the path MTU discovery process on unconnected sockets it
is possible to start with a big datagram size
(up to 64K-headers bytes long) and let it shrink by updates of the path MTU.
.\" XXX this is an ugly hack
.\" FIXME this is an ugly hack
To get an initial estimate of the
path MTU connect a datagram socket to the destination address using
@ -772,9 +772,9 @@ bytes.
.B neigh/*
See
.BR arp (7).
.\" XXX Document the conf/*/* sysctls
.\" XXX Document the route/* sysctls
.\" XXX document them all
.\" FIXME Document the conf/*/* sysctls
.\" FIXME Document the route/* sysctls
.\" FIXME document them all
.SH IOCTLS
All ioctls described in
.BR socket (7)
@ -788,7 +788,7 @@ package.
.PP
Ioctls to configure generic device parameters are described in
.BR netdevice (7).
.\" XXX Add a chapter about multicasting
.\" FIXME Add a chapter about multicasting
.SH NOTES
Be very careful with the
.B SO_BROADCAST
@ -821,7 +821,7 @@ socket options level isn't portable, BSD-based stacks use
.I IPPROTO_IP
level.
.SH ERRORS
.\" XXX document all errors.
.\" FIXME document all errors.
.\" We should really fix the kernels to give more uniform
.\" error returns (ENOMEM vs ENOBUFS, EPERM vs EACCES etc.)
.TP
@ -978,4 +978,4 @@ RFC\ 791 for the original IP specification.
RFC\ 1122 for the IPv4 host requirements.
.br
RFC\ 1812 for the IPv4 router requirements.
\" LocalWords: XXX autobind INADDR REUSEADDR
\" LocalWords: FIXME autobind INADDR REUSEADDR

View File

@ -214,14 +214,14 @@ is equal to the original length the buffer probably has overflowed
and you should retry with a bigger buffer to get all addresses.
When no error occurs the ioctl returns 0;
otherwise \-1. Overflow is not an error.
\" XXX Slaving isn't supported in 2.2
\" FIXME Slaving isn't supported in 2.2
.\" .TP
.\" .BR SIOCGIFSLAVE ", " SIOCSIFSLAVE
.\" Get or set the slave device using
.\" .BR ifr_slave .
.\" Setting the slave device is a privileged operation.
.\" .PP
.\" XXX add amateur radio stuff.
.\" FIXME add amateur radio stuff.
.PP
Most protocols support their own ioctls to configure protocol specific
interface options. See the protocol man pages for a description.

View File

@ -9,7 +9,7 @@
netlink, PF_NETLINK \- Communication between kernel and user
.SH SYNOPSIS
.nf
.\" XXX
.\" FIXME
.B #include <asm/types.h>
.br
.B #include <sys/socket.h>
@ -172,7 +172,7 @@ NLM_F_MULTI:T{
the message is part of a multipart message terminated by
.B
NLMSG_DONE
.\" XXX describe that
.\" FIXME describe that
T}
NLM_F_ACK:reply with an acknowledgment on success
NLM_F_ECHO:echo this request
@ -226,7 +226,7 @@ is the PID of the process owning the destination socket, or 0 if the
destination is in the kernel.
.B nl_groups
is a bitmask with every bit representing a netlink group number.
.\" XXX describe what that is.
.\" FIXME describe what that is.
.SH BUGS

View File

@ -35,7 +35,7 @@ sockets. It is based on netlink messages, see
.BR netlink (7)
for more information.
.\" XXX: all these macros could be moved to rtnetlink(3)
.\" FIXME: all these macros could be moved to rtnetlink(3)
.SH "ROUTING ATTRIBUTES"
Some rtnetlink messages have optional attributes after the initial header:
@ -78,7 +78,7 @@ struct ifinfomsg
};
.fi
.\" XXX ifi_type
.\" FIXME ifi_type
.B ifi_flags
contains the device flags, see
.BR netdevice(7);
@ -164,7 +164,7 @@ IFA_ANYCAST:raw protocol address:anycast address
IFA_CACHEINFO:struct ifa_cacheinfo:Address information.
.TE
.\" XXX struct ifa_cacheinfo
.\" FIXME struct ifa_cacheinfo
.TP
.BR RTM_NEWROUTE ", " RTM_DELROUTE ", " RTM_GETROUTE
Create, remove or receive information about a network route.

View File

@ -167,7 +167,7 @@ Urgent data arrived.
.B SIGURG
is sent then.
T}
.\" XXX not true currently
.\" FIXME not true currently
.\" It is no I/O event when the connection
.\" is broken from the local end using
.\" .BR shutdown (2)