home *** CD-ROM | disk | FTP | other *** search
/ PC Press 1997 July / Sezamfile97_1.iso / msdos / clipper / ft_doc.arj / REBUILD.TXT < prev    next >
Text File  |  1992-01-18  |  6KB  |  152 lines
  1. !short: Recompiling the source code
  2. '------------------------------------------------------------------------------
  3.  
  4.     ^bThe Nanforum Toolkit Master Makefile
  5.  
  6.     This makefile will allow you to use RMAKE, provided with every
  7.     Clipper 5.0 package, to maintain your own copy of the Nanforum
  8.     Toolkit.  It is also a good example of how to use RMAKE on a
  9.     large project.  This is the exact copy used by the Nanforum Toolkit
  10.     librarian.
  11.  
  12.     To use it, you must first understand what it does, and what your
  13.     limitations are.  A discussion of MAKE utlities is beyond the scope
  14.     of this comment; read the Clipper documentation, or the Norton Guide
  15.     file, for more information on RMAKE.
  16.  
  17.     ^b*** Compilers and Assemblers you need
  18.  
  19.     Note that currently, Nanforum Toolkit sources are written in
  20.     Assembly language, Clipper, and C.  Within the realm of assembly
  21.     language, our contributors have submitted code that is designed
  22.     for Borland's Turbo Assembler (TASM) and Microsoft's Macro Assembler
  23.     (MASM).  So, right now, in order to do a perfect re-build of the
  24.     Nanforum Toolkit, you must have these tools:
  25.  
  26.          Microsoft C (v5.1 or later)
  27.          Microsoft Macro Assembler (v 5.1 or later)
  28.          Borland Turbo Assembler
  29.          Nantucket Clipper v5.0 or later
  30.  
  31.     If you know much about assembly language, you can convert MASM
  32.     sources to TASM and vice versa, but that is up to you.
  33.  
  34.     ^b*** Library Utility
  35.  
  36.     In addition, you must have a library utility.  Microsoft supplies
  37.     LIB.EXE with its Compiler products, for example.  LIB will work
  38.     fine with this makefile.  Note that we assume a command line syntax
  39.     for library utilities that works like this:
  40.  
  41.          lib <libname> -+ objname
  42.  
  43.     Note the "-+" directive, indicating "replace module."  If your
  44.     library utility does not support this syntax on the command line,
  45.     then you will have to edit the relevant lines in the makefile.
  46.  
  47.     ^b*** Assumptions about your environment
  48.  
  49.     NFMAKE.RMK makes just a few assumptions about your environment:
  50.  
  51.                Assumption            What to change if we're wrong
  52.                ----------            -----------------------------
  53.  
  54.     Relevant environment             Either edit the makefile to
  55.     variables for each compiler/     set the envars, or setup your
  56.     assembler are already            autoexec.bat to set them on bootup.
  57.     set (i.e., LIB=, INCLUDE=)       See your compiler doc.
  58.  
  59.     Microsoft C is being             Look for the .C source inference
  60.     used                             rule below, and change it to your
  61.                                      compiler, making sure your switches
  62.                                      are correct.  Note that some source
  63.                                      may not compile without MSC, so edits
  64.                                      may be required.  Try to use MSC.
  65.  
  66.     Microsoft Assembler              Look for all occurences of MASM in
  67.     executable is called             this makefile and change them to
  68.     MASM.EXE                         whatever *you* call MASM.
  69.  
  70.     Clipper compiler executable      Look for all occurences of "Clipper" in
  71.     is called CLIPPER.EXE            this makefile and change them to
  72.                                      whatever *you* call Clipper.
  73.  
  74.     Microsoft C executable is        Look for all occurences of "CL" in this
  75.     called CL.EXE                    makefile and change them to whatever
  76.                                      *you* call CL.
  77.  
  78.  
  79.     ^b*** Customizing the Makefile
  80.  
  81.     We have tried not to assume anything about your environment except
  82.     what is described above.  To achieve that flexibility, you must
  83.     check and set some macros that can be found just below this
  84.     documentation.  They are:
  85.  
  86.          l         Path to the resulting library (i.e., \nanfor\lib)
  87.          o         Path to where .obj files should be put
  88.          s         Path to where the source code is found
  89.         c5         Path to Clipper 5.0 compiler .EXE
  90.         ma         Path to Microsoft Macro Assembler .EXE
  91.         ta         Path to Turbo Assembler .EXE
  92.         mc         Path to Microsoft C 5.1
  93.         ml         Path and name of library utility (i.e., \bin\lib)
  94.  
  95.      Note that directory paths should *not* end in a backslash.
  96.      If you like to keep your .obj and source files in the same
  97.      directory, simply point the paths to the same place.
  98.  
  99.      ^b*** What happens when you don't have a compiler
  100.  
  101.      If RMAKE can't find the compiler in the directory you specified,
  102.      then the relevant files designed for that compiler will not be
  103.      built, and the resultant objs won't be replaced in your library.
  104.      You will get an error message.
  105.  
  106.      ^b*** Suggestions for setting up a "rebuilding environment"
  107.  
  108.      Should you want to rebuild, the following is suggested:
  109.  
  110.      First, make sure you keep an unmodified NANFOR.LIB, downloaded
  111.      from the forum, in a safe place.  Do not modify it.
  112.  
  113.      Next, create a directory structure like this
  114.  
  115.      \nanfor
  116.          \obj
  117.          \src
  118.  
  119.      Put this makefile in \nanfor, and all source code into
  120.      \nanfor\src.
  121.  
  122.      Customize the makefile in \nanfor for your environment.
  123.      The default macros below assume you're using this arrangement.
  124.  
  125.      Type RMAKE NFMAKE.RMK.  The .obj files should be left in
  126.      \nanfor\obj, and the new NANFOR.LIB should be in \nanfor.
  127.  
  128.      Note that as new releases of the library come out, you may have
  129.      a lot of work incorporating additions and modifications.  So,
  130.      plan your rebuilding efforts carefully.
  131.  
  132.      ^b*** Problems, bugs, support
  133.  
  134.      Support for this makefile can be found on CompuServe, in the
  135.      Nantucket Forum (NANFORUM).  Leave messages in section 5 ("User
  136.      Lib").  Updates and patches will be posted in Library 7.
  137. !seealso: "Recompiling the Norton Guide" 
  138. '------------------------------------------------------------------------------
  139.  
  140.  
  141.  
  142. !short: Recompiling the Norton Guide
  143. '------------------------------------------------------------------------------
  144.  
  145.  
  146.     *** instructions on how to rebuild the NG go here ***
  147. !seealso: "Recompiling the source code" 
  148. '------------------------------------------------------------------------------
  149.  
  150.  
  151.  
  152.