README.template

   1 This directory contains the %VERSION% release of GNU Make.
   2
   3 See the file NEWS for the user-visible changes from previous releases.
   4 In addition, there have been bugs fixed.
   5
   6 Please check the system-specific notes below for any caveats related to
   7 your operating system.
   8
   9 For general building and installation instructions, see the file INSTALL.
  10
  11 If you need to build GNU Make and have no other `make' program to use,
  12 you can use the shell script `build.sh' instead.  To do this, first run
  13 `configure' as described in INSTALL.  Then, instead of typing `make' to
  14 build the program, type `sh build.sh'.  This should compile the program
  15 in the current directory.  Then you will have a Make program that you can
  16 use for `./make install', or whatever else.
  17
  18 Some systems' Make programs are broken and cannot process the Makefile for
  19 GNU Make.  If you get errors from your system's Make when building GNU
  20 Make, try using `build.sh' instead.
  21
  22
  23 GNU Make is free software.  See the file COPYING for copying conditions.
  24
  25
  26 Downloading
  27 -----------
  28
  29 GNU Make can be obtained in many different ways.  See a description here:
  30
  31   http://www.gnu.org/software/software.html
  32
  33
  34 Documentation
  35 -------------
  36
  37 GNU make is fully documented in the GNU Make manual, which is contained
  38 in this distribution as the file make.texinfo.  You can also find
  39 on-line and preformatted (PostScript and DVI) versions at the FSF's web
  40 site.  There is information there about ordering hardcopy documentation.
  41
  42   http://www.gnu.org/
  43   http://www.gnu.org/doc/doc.html
  44   http://www.gnu.org/manual/manual.html
  45
  46
  47 Development
  48 -----------
  49
  50 GNU Make development is hosted by Savannah, the FSF's online development
  51 management tool.  Savannah is here:
  52
  53   http://savannah.gnu.org
  54
  55 And the GNU Make development page is here:
  56
  57   http://savannah.gnu.org/projects/make/
  58
  59 You can find most information concerning the development of GNU Make at
  60 this site.
  61
  62
  63 Bug Reporting
  64 -------------
  65
  66 You can send GNU make bug reports to <bug-make@gnu.org>.  Please see the
  67 section of the GNU make manual entitled `Problems and Bugs' for
  68 information on submitting useful and complete bug reports.
  69
  70 You can also use the online bug tracking system in the Savannah GNU Make
  71 project to submit new problem reports or search for existing ones:
  72
  73   http://savannah.gnu.org/bugs/?group=make
  74
  75 If you need help using GNU make, try these forums:
  76
  77   help-make@gnu.org
  78   help-utils@gnu.org
  79   news:gnu.utils.help
  80   news:gnu.utils.bug
  81
  82   http://savannah.gnu.org/support/?group=make
  83
  84 You may also find interesting patches to GNU Make available here:
  85
  86   http://savannah.gnu.org/patch/?group=make
  87
  88 Note these patches are provided by our users as a service and we make no
  89 statements regarding their correctness.  Please contact the authors
  90 directly if you have a problem or suggestion for a patch available on
  91 this page.
  92
  93
  94 CVS Access
  95 ----------
  96
  97 The GNU make source repository is available via anonymous CVS from the
  98 GNU Subversions CVS server; look here for details:
  99
 100   http://savannah.gnu.org/cvs/?group=make
 101
 102 Please note: you won't be able to build GNU make from CVS without
 103 installing appropriate maintainer's tools, such as GNU m4, automake,
 104 autoconf, Perl, GNU make, and GCC.  See the README.cvs file for hints on
 105 how to build GNU make once these tools are available.  We make no
 106 guarantees about the contents or quality of the latest code in the CVS
 107 repository: it is not unheard of for code that is known to be broken to
 108 be checked in.  Use at your own risk.
 109
 110
 111 System-specific Notes
 112 ---------------------
 113
 114 It has been reported that the XLC 1.2 compiler on AIX 3.2 is buggy such
 115 that if you compile make with `cc -O' on AIX 3.2, it will not work
 116 correctly.  It is said that using `cc' without `-O' does work.
 117
 118 The standard /bin/sh on SunOS 4.1.3_U1 and 4.1.4 is broken and cannot be
 119 used to configure GNU make.  Please install a different shell such as
 120 bash or pdksh in order to run "configure".  See this message for more
 121 information:
 122   http://mail.gnu.org/archive/html/bug-autoconf/2003-10/msg00190.html
 123
 124 One area that is often a problem in configuration and porting is the code
 125 to check the system's current load average.  To make it easier to test and
 126 debug this code, you can do `make check-loadavg' to see if it works
 127 properly on your system.  (You must run `configure' beforehand, but you
 128 need not build Make itself to run this test.)
 129
 130 Another potential source of porting problems is the support for large
 131 files (LFS) in configure for those operating systems that provide it.
 132 Please report any bugs that you find in this area.  If you run into
 133 difficulties, then as a workaround you should be able to disable LFS by
 134 adding the `--disable-largefile' option to the `configure' script.
 135
 136 On systems that support micro- and nano-second timestamp values and
 137 where stat(2) provides this information, GNU make will use it when
 138 comparing timestamps to get the most accurate possible result.  However,
 139 note that many current implementations of tools that *set* timestamps do
 140 not preserve micro- or nano-second granularity.  This means that "cp -p"
 141 and other similar tools (tar, etc.) may not exactly duplicate timestamps
 142 with micro- and nano-second granularity on some systems.  If your build
 143 system contains rules that depend on proper behavior of tools like "cp
 144 -p", you should consider using the .LOW_RESOLUTION_TIME pseudo-target to
 145 force make to treat them properly.  See the manual for details.
 146
 147
 148 Ports
 149 -----
 150
 151   - See README.customs for details on integrating GNU make with the
 152     Customs distributed build environment from the Pmake distribution.
 153
 154   - See readme.vms for details about GNU Make on OpenVMS.
 155
 156   - See README.Amiga for details about GNU Make on AmigaDOS.
 157
 158   - See README.W32 for details about GNU Make on Windows NT, 95, or 98.
 159
 160   - See README.DOS for compilation instructions on MS-DOS and MS-Windows
 161     using DJGPP tools.
 162
 163     A precompiled binary of the MSDOS port of GNU Make is available as part
 164     of DJGPP; see the WWW page http://www.delorie.com/djgpp/ for more
 165     information.
 166
 167 Please note there are two _separate_ ports of GNU make for Microsoft
 168 systems: a native Windows tool built with (for example) MSVC or Cygwin,
 169 and a DOS-based tool built with DJGPP.  Please be sure you are looking
 170 at the right README!
 171
 172 \f
 173 -------------------------------------------------------------------------------
 174 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
 175 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software
 176 Foundation, Inc.
 177 This file is part of GNU Make.
 178
 179 GNU Make is free software; you can redistribute it and/or modify it under the
 180 terms of the GNU General Public License as published by the Free Software
 181 Foundation; either version 3 of the License, or (at your option) any later
 182 version.
 183
 184 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
 185 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 186 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 187
 188 You should have received a copy of the GNU General Public License along with
 189 this program.  If not, see <http://www.gnu.org/licenses/>.