Source code in programming faq

---------

Vic Metcalfe (vam@brutus.tlug.org)
Tue, 23 Apr 1996 08:44:39 -0400 (EDT)


I maintain the unix-socket-faq, which is for unix network programming.
There is a section at the bottom of my faq which contains sample source
code. Samples are really important to programming documentation, as most
programmers learn better from seeing a working model than from reading
about one. The last issue of the faq grew past 64K, and inews wouldn't
accept the posting, so I had to strip the source code from the bottom of
the faq to make room.

The problem is that the source is provided in tarred zipped uuencoded
format, and as such is seen as a binary posting. I do this because it is
smaller than un-compressed text, and because it is easier to extract all
the files, with correct file names and paths so that readers can compile
and mess around with the examples. I understand many sites will
automatically dispose of binary postings, and I seem to remember binary
postings being not acceptable faq material.

I am thinking about making the source into a part 2 section of the faq,
and putting it in the form of a shell script, so that users that want to
try it out can simply edit out the usenet header and run it to get the
files created. This would generate a larger posting, but it would be
readable by human eyes.

Would this be acceptable? Does anyone have any better ideas? I've
already had several requests for the source from people with access to
only news and mail (uucp, fidonet, etc), so I don't think web and ftp
really solve the problem.

Thanks for any suggestions you might have,
Vic.



[ Usenet Hypertext FAQ Archive | Search Mail Archive | Authors | Usenet ]
[ 1993 | 1994 | 1995 | 1996 | 1997 ]

---------

faq-admin@landfield.com

© Copyright The Landfield Group, 1997
All rights reserved