xref: /freebsd/contrib/file/MAINT (revision d1d50c78ab5592e27e6f1dc9657dc4c8eb8fdc9e)
1d1d50c78SDavid E. O'Brien$Id: MAINT,v 1.7 2006/06/01 18:19:41 ian Exp $
275a6cdb3SDavid E. O'Brien
375a6cdb3SDavid E. O'BrienMaintenance notes:
475a6cdb3SDavid E. O'Brien
575a6cdb3SDavid E. O'BrienI am continuing to maintain the file command. I welcome your help,
675a6cdb3SDavid E. O'Brienbut to make my life easier I'd like to request the following:
775a6cdb3SDavid E. O'Brien
875a6cdb3SDavid E. O'Brien- Don't change the version numbers!
975a6cdb3SDavid E. O'Brien
1075a6cdb3SDavid E. O'BrienIf your changes are extensive, I will have to work hard to
1175a6cdb3SDavid E. O'Brienintegrate them into my version.  If you check it into SCCS locally,
1275a6cdb3SDavid E. O'Brienthe version numbers will likely be kept. IF you check it into RCS
1375a6cdb3SDavid E. O'Brienor CVS locally, please use -k to keep the version numbers, and
1475a6cdb3SDavid E. O'Brienplease use branch deltas (1.21.1, 1.21.2, ...).  If you don't do
1575a6cdb3SDavid E. O'Brienthis, I will likely be unable to use your changes; life's just too
1675a6cdb3SDavid E. O'Brienshort.
1775a6cdb3SDavid E. O'Brien
1875a6cdb3SDavid E. O'Brien- Do not distribute changed versions.
1975a6cdb3SDavid E. O'Brien
2075a6cdb3SDavid E. O'BrienPeople trying to be helpful occasionally put up their hacked versions
21d1d50c78SDavid E. O'Brienof the file command for anonymous FTP, and people all over the
22d1d50c78SDavid E. O'Brienworld get copies of the hacked versions.  Within a day or two I am
23d1d50c78SDavid E. O'Briengetting email from around the world asking me why "my" file command
24d1d50c78SDavid E. O'Brienwon't compile!!! Needless to say this detracts from the limited
25d1d50c78SDavid E. O'Brientime I have available to work on the actual software. Therefore I
26d1d50c78SDavid E. O'Brienask you again to please NOT distribute your changed version. If
27d1d50c78SDavid E. O'Brienyou need to make changes, please add a patch file next to the
28d1d50c78SDavid E. O'Briendistribution tar, and a README file that clearly explains what you
29d1d50c78SDavid E. O'Brienare trying to fix.
3075a6cdb3SDavid E. O'Brien
3175a6cdb3SDavid E. O'BrienThank you for your assistance and cooperation.
3275a6cdb3SDavid E. O'Brien
33d1d50c78SDavid E. O'BrienCode Overview
34d1d50c78SDavid E. O'Brien
35d1d50c78SDavid E. O'BrienThis is a rough idea of the control flow from the main program:
36d1d50c78SDavid E. O'Brien
37d1d50c78SDavid E. O'Brienfile.c	main()
38d1d50c78SDavid E. O'Brienfile.c	process (called for each file)
39d1d50c78SDavid E. O'Brien		printf file name
40d1d50c78SDavid E. O'Brienmagic.c		magic_file()
41d1d50c78SDavid E. O'Brienfsmagic.c		file_fsmagic()
42d1d50c78SDavid E. O'Brien				(handles statbuf modes for DEV)
43d1d50c78SDavid E. O'Brien			(handles statbuf modes for executable &c.
44d1d50c78SDavid E. O'Brien			reads data from file.
45d1d50c78SDavid E. O'Brienfuncs.c:		file_buffer()
46d1d50c78SDavid E. O'Briencompress.c			file_zmagic()
47d1d50c78SDavid E. O'Brienis_tar.c			file_is_tar()
48d1d50c78SDavid E. O'Briensoftmagic.c			file_softmagic()
49d1d50c78SDavid E. O'Brien						match() - looks for match against main magic database
50d1d50c78SDavid E. O'Brienascmagic.c			file_ascmagic()
51d1d50c78SDavid E. O'Brienreadelf.c		file_tryelf()
52d1d50c78SDavid E. O'Brien				"unknown"
53d1d50c78SDavid E. O'Brien
5475a6cdb3SDavid E. O'BrienChristos Zoulas
5575a6cdb3SDavid E. O'Brienchristos@astron.com
56