Add the description of some hard-learnt restrictions and a workaround.

1 files changed, 22 insertions, 1 deletions

diff --git a/usr.sbin/crunch/crunchgen/crunchgen.1 b/usr.sbin/crunch/crunchgen/crunchgen.1
index b30bc80..825b00a 100644
--- a/usr.sbin/crunch/crunchgen/crunchgen.1
+++ b/usr.sbin/crunch/crunchgen/crunchgen.1
@@ -48,7 +48,7 @@ as many programs as possible onto an installation or system recovery
 floppy.
 
 .Pp
-.Nm Crunchgen
+.Nm
 reads in the specifications in
 .Ar conf-file
 for a crunched binary, and generates a Makefile and accompanying
@@ -65,6 +65,27 @@ to eliminate link-time conflicts between the component programs by
 hiding all unnecessary symbols.
 
 .Pp
+.Nm 
+places specific requirements on package
+.Pa Makefiles
+which make it unsuitable for use with non-BSD sources.  In particular, the
+.Nm Makefile
+must contain the target
+.Ar depend ,
+and it must define all object files in the variable
+.Ar OBJS .
+In some cases, you can use a fake
+.Pa Makefile :
+before looking for
+.Pa Makefile
+in the source directory
+.Pa foo ,
+.Nm
+looks for the file
+.Pa Makefile.foo
+in the current directory.
+
+.Pp
 After
 .Nm
 is run, the crunched binary can be built by running ``make -f