contrib/file-4/MAINT

   1 $Id: MAINT,v 1.7 2006/06/01 18:19:41 ian Exp $
   2
   3 Maintenance notes:
   4
   5 I am continuing to maintain the file command. I welcome your help,
   6 but to make my life easier I'd like to request the following:
   7
   8 - Don't change the version numbers!
   9
  10 If your changes are extensive, I will have to work hard to
  11 integrate them into my version.  If you check it into SCCS locally,
  12 the version numbers will likely be kept. IF you check it into RCS
  13 or CVS locally, please use -k to keep the version numbers, and
  14 please use branch deltas (1.21.1, 1.21.2, ...).  If you don't do
  15 this, I will likely be unable to use your changes; life's just too
  16 short.
  17
  18 - Do not distribute changed versions.
  19
  20 People trying to be helpful occasionally put up their hacked versions
  21 of the file command for anonymous FTP, and people all over the
  22 world get copies of the hacked versions.  Within a day or two I am
  23 getting email from around the world asking me why "my" file command
  24 won't compile!!! Needless to say this detracts from the limited
  25 time I have available to work on the actual software. Therefore I
  26 ask you again to please NOT distribute your changed version. If
  27 you need to make changes, please add a patch file next to the
  28 distribution tar, and a README file that clearly explains what you
  29 are trying to fix.
  30
  31 Thank you for your assistance and cooperation.
  32
  33 Code Overview
  34
  35 This is a rough idea of the control flow from the main program:
  36
  37 file.c  main()
  38 file.c  process (called for each file)
  39                 printf file name
  40 magic.c         magic_file()
  41 fsmagic.c               file_fsmagic()
  42                                 (handles statbuf modes for DEV)
  43                         (handles statbuf modes for executable &c.
  44                         reads data from file.
  45 funcs.c:                file_buffer()
  46 compress.c                      file_zmagic()
  47 is_tar.c                        file_is_tar()
  48 softmagic.c                     file_softmagic()
  49                                                 match() - looks for match against main magic database
  50 ascmagic.c                      file_ascmagic()
  51 readelf.c               file_tryelf()
  52                                 "unknown"
  53
  54 Christos Zoulas
  55 christos@astron.com