Reply-To: daniel@compass-da.com
Sender: daniel@compass-da.com
Message-Id: <337DCDF7.79EA6552@compass-da.com>
Date: Sat, 17 May 1997 11:25:43 -0400
From: "Daniel S. Barclay" <daniel@compass-da.com>
Mime-Version: 1.0
To: submit@bugs.debian.org
Subject: TCPOPT_EOL, TCPOPT_NOP, and TCPOPT_MAXSEG not documented
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Package: unknown
Version: unknown

The following applies to Debian 1.2.x upgraded to Debian 1.2.15 as of
1997-05-17.

It appears that the system contains no documentation for the
preprocessor 
constants TCPOPT_EOL, TCPOPT_NOP, and TCPOPT_MAXSEG defined in
/usr/include/netinen/ip_tcp.h.

(Two of them are apparently for the "optname" argument of the
getsockopt() 
system call, but I can't be sure even of that.)  

I ran grep and zgrep (for "TCPOPT") on every file on my entire system. 
(I think 
I have most normal packages installed.)

- There is no mention in any manual page, info page, or /usr/doc file.

- The include file /usr/include/netinen/ip_tcp.h gives absolutely no 
	documentation.  It only contains the "#define" directives to define the
	constants.  

	It does not say what the options mean.

	It does not even say that they are for the "optname" argument of 
	getsockopt().

	It certainly does not define how to interpret the "optval" argument of
	getsockopt().


- /usr/src/kernel-source-2.0.27/include/net/tcp.h has only two words
	(average) of description of it's version of each option:
	#define TCPOPT_NOP	1	/* Padding */
	#define TCPOPT_EOL	0	/* End of options */
	#define TCPOPT_MSS	2	/* Segment size negotiating */

	This also give no information about whether these can be used with
	getsockopt() or not.

- /usr/src/kernel-source-2.0.27/net/ipv4/tcp_input.c uses the above
constants
	 but contains no documentation of them.


-- 
Daniel S. Barclay
daniel@compass-da.com / dsb@smart.net