Bug#321201: kernel-doc: put an ### END ### at the end of files that lack them

[Horms <horms@debian.org>]

On Thu, Aug 04, 2005 at 07:42:45AM +0800, Dan Jacobson wrote:
> Package: kernel-doc-2.6.8
> Version: 2.6.8-10
> Severity: wishlist
> File: /usr/share/doc/kernel-doc-2.6.8/Documentation/networking/PLIP.txt.gz
> Tags: upstream
> 
> The document seems to end abruptly with
> 
>    WAIT FOR IN.4 = 0
> 
> and might be truncated. Perhaps if there were as "Conclusion" section
> added, one could tell that the document was not truncated.
> 
> Same for any other kernel documents, and all kernel versions, etc.
> Compare /kernel-doc-2.6.8/Documentation/usb/proc_usb_info.txt.gz which
> has an ### END ### at the end.

I see no reason that isn't the end of the document,
and I also see no evidence that there is a standard
of adding ### END ### to kernel documentation.

I have CCed Donald Becker, who seems to be the author, 
hopefully he can comment on the completeness of the document.
I've included the trailing portion of the document for
his benifit.

-- 
Horms

PLIP Mode 0 transfer protocol
=============================

The PLIP driver is compatible with the "Crynwr" parallel port transfer
standard in Mode 0.  That standard specifies the following protocol:

   send header nibble '0x8'
   count-low octet
   count-high octet
   ... data octets
   checksum octet

Each octet is sent as
        <wait for rx. '0x1?'>   <send 0x10+(octet&0x0F)>
        <wait for rx. '0x0?'>   <send 0x00+((octet>>4)&0x0F)>

To start a transfer the transmitting machine outputs a nibble 0x08.
That raises the ACK line, triggering an interrupt in the receiving
machine.  The receiving machine disables interrupts and raises its own
ACK
line.

Restated:

(OUT is bit 0-4, OUT.j is bit j from OUT. IN likewise)
Send_Byte:
   OUT := low nibble, OUT.4 := 1
   WAIT FOR IN.4 = 1
   OUT := high nibble, OUT.4 := 0
   WAIT FOR IN.4 = 0