summaryrefslogtreecommitdiff
path: root/README.in
diff options
context:
space:
mode:
authorPaul Smith <psmith@gnu.org>2022-10-16 15:13:41 -0400
committerPaul Smith <psmith@gnu.org>2022-10-18 14:20:44 -0400
commit2d943d3d2e5b69d6b635314a46d20e55cfbd255a (patch)
treeeb272d7661251ee0aecdf5357519c734110cbea1 /README.in
parentb16913a67e1d0f651293d24f10ccca54a8cc0d08 (diff)
downloadmake-git-2d943d3d2e5b69d6b635314a46d20e55cfbd255a.tar.gz
Remove template files to simplify distribution creation
The README templates were not useful since the replacement step didn't have anything to replace: rename them. Rather than creating template files for the config variants, create mkconfig.h.in containg PACKAGE_* variables to be replaced, and have config variant header files include it. Note on POSIX we don't use this, and continue to generate a single config.h.in file. Use config.status to convert the README.in and mkconfig.h.in files during distribution creation. Modify all users of VERSION to use PACKAGE_VERSION instead. * configure.ac: Use GNU Make not GNU make as the package name. * README.in: Use GNU Make not GNU make. * README.git: Remove references to README.W32.template. * .gitignore: Update for new behavior. * Basic.mk.template: Remove unused posix_SOURCES and VERSION, and references to unshipped mk/Posix.mk * Makefile.am: Add src/mkconfig.h as an extra dist file. * bootstrap.bat: Rewrite mkconfig.h.in to mkconfig.h * maintMakefile: Remove obsolete template files; add mkconfig.h.in. * prepare_vms.com: Rewrite mkconfig.h.in to mkconfig.h * mk/VMS.mk: Fix incorrect header file prerequisite. * src/mkconfig.h.in: New file containing PACKAGE variables. * src/config.ami: Include mkconfig.h. * src/config.h.W32: Ditto. * src/configh.dos: Ditto. * src/config.h-vms: Ditto. * src/version.c: Use PACKAGE_VERSION not VERSION.
Diffstat (limited to 'README.in')
-rw-r--r--README.in208
1 files changed, 208 insertions, 0 deletions
diff --git a/README.in b/README.in
new file mode 100644
index 00000000..4ef14a6a
--- /dev/null
+++ b/README.in
@@ -0,0 +1,208 @@
+This directory contains the @PACKAGE_VERSION@ release of @PACKAGE_NAME@.
+
+See the file NEWS for the user-visible changes from previous releases.
+In addition, there have been bugs fixed.
+
+Please check the system-specific notes below for any caveats related to your
+operating system.
+
+If you are trying to build GNU Make from a Git clone rather than a downloaded
+source distribution, see the README.git file for instructions.
+
+For source distribution building and installation instructions, see the file
+INSTALL.
+
+If you need to build GNU Make and have no other 'make' program to use, you can
+use the shell script 'build.sh' instead. To do this, first run 'configure' as
+described in INSTALL. Then, instead of typing 'make' to build the program,
+type 'sh build.sh'. This will compile the program in the current directory.
+Then you will have a 'make' program that you can use for './make install', or
+whatever else.
+
+Some systems' 'make' programs cannot process the Makefile for GNU Make.
+If you get errors from your system's 'make' when building GNU Make, try using
+'build.sh' instead.
+
+
+GNU Make is free software. See the file COPYING for copying conditions.
+GNU Make is copyright by the Free Software Foundation. Copyright notices
+condense sequential years into a range; e.g. "1987-1994" means all years
+from 1987 to 1994 inclusive.
+
+Downloading
+-----------
+
+GNU Make can be obtained in many different ways. See a description here:
+
+ https://www.gnu.org/software/software.html
+
+
+Documentation
+-------------
+
+GNU Make is fully documented in the GNU Make manual, which is contained in
+this distribution as the file make.texi. You can also find on-line and
+preformatted (PostScript and DVI) versions at the FSF's web site. There is
+information there about ordering hardcopy documentation.
+
+ https://www.gnu.org/
+ https://www.gnu.org/doc/doc.html
+ https://www.gnu.org/manual/manual.html
+
+
+Development
+-----------
+
+GNU Make development is hosted by Savannah, the FSF's online development
+management tool. Savannah is here:
+
+ https://savannah.gnu.org
+
+And the GNU Make development page is here:
+
+ https://savannah.gnu.org/projects/make/
+
+You can find most information concerning the development of GNU Make at
+this site.
+
+
+Bug Reporting
+-------------
+
+If you need help using GNU Make, try asking on <help-make@gnu.org>.
+
+If you found a bug, you can send a bug reports to <bug-make@gnu.org>.
+Please see the section of the GNU Make manual entitled 'Problems and Bugs'
+for information on submitting useful and complete bug reports.
+
+You do not need to subscribe to these lists first.
+
+You can also use the online bug tracking system in the Savannah GNU Make
+project to submit new problem reports or search for existing ones:
+
+ https://savannah.gnu.org/bugs/?group=make
+
+We prefer to use the bug tracking system ONLY for bugs or enhancements,
+not for help requests: please use the mailing lists to get help.
+
+
+Submitting Patches
+------------------
+
+If you'd like to propose a change to GNU Make, you can provide a patch with
+your changes. If you are making your changes in a Git workspace you can run
+"git format-patch" to create a patch file. If not, you can use the diff(1)
+utility to create a patch file; please use "diff -u".
+
+Once you have a patch you can submit it in any of these ways:
+
+ * Create a bug on Savannah and add the patch as an attachment:
+ https://savannah.gnu.org/bugs/?group=make&func=additem
+
+ * Send the patch via email to <bug-make@gnu.org>: be sure to add it as an
+ attachment to avoid interference by email processors.
+
+All non-trivial changes require FSF copyright paperwork to be completed
+before they can be accepted. Contact <bug-make@gnu.org> for help.
+
+
+Git Access
+----------
+
+The GNU Make source repository is available via Git from the GNU Savannah Git
+server; look here for details:
+
+ https://savannah.gnu.org/git/?group=make
+
+Please note: you won't be able to build GNU Make from Git without installing
+appropriate maintainer's tools, such as GNU m4, automake, autoconf, Perl, GNU
+make, and GCC.
+
+See the README.git file for instructions on how to build GNU Make once these
+tools are available. We make no guarantees about the contents or quality of
+the latest code in the Git repository: it is not unheard of for code that is
+known to be broken to be checked in. Use at your own risk.
+
+
+System-specific Notes
+---------------------
+
+It has been reported that the XLC 1.2 compiler on AIX 3.2 is buggy such
+that if you compile make with 'cc -O' on AIX 3.2, it will not work
+correctly. It is said that using 'cc' without '-O' does work.
+
+The standard /bin/sh on SunOS 4.1.3_U1 and 4.1.4 is broken and cannot be
+used to configure GNU Make. Please install a different shell such as
+bash or pdksh in order to run "configure". See this message for more
+information:
+ https://mail.gnu.org/archive/html/bug-autoconf/2003-10/msg00190.html
+
+One area that is often a problem in configuration and porting is the code
+to check the system's current load average. To make it easier to test and
+debug this code, you can do 'make check-loadavg' to see if it works
+properly on your system. (You must run 'configure' beforehand, but you
+need not build 'make' itself to run this test.)
+
+Another potential source of porting problems is the support for large
+files (LFS) in configure for those operating systems that provide it.
+Please report any bugs that you find in this area. If you run into
+difficulties, then as a workaround you should be able to disable LFS by
+adding the '--disable-largefile' option to the 'configure' script.
+
+On systems that support micro- and nano-second timestamp values and
+where stat(2) provides this information, GNU Make will use it when
+comparing timestamps to get the most accurate possible result. However,
+note that many current implementations of tools that *set* timestamps do
+not preserve micro- or nano-second granularity. This means that "cp -p"
+and other similar tools (tar, etc.) may not exactly duplicate timestamps
+with micro- and nano-second granularity on some systems. If your build
+system contains rules that depend on proper behavior of tools like "cp
+-p", you should consider using the .LOW_RESOLUTION_TIME pseudo-target to
+force make to treat them properly. See the manual for details.
+
+
+Ports
+-----
+
+ - See README.customs for details on integrating GNU Make with the
+ Customs distributed build environment from the Pmake distribution.
+
+ - See README.VMS for details about GNU Make on OpenVMS.
+
+ - See README.Amiga for details about GNU Make on AmigaDOS.
+
+ - See README.W32 for details about GNU Make on Windows NT, 95, or 98.
+
+ - See README.DOS for compilation instructions on MS-DOS and MS-Windows
+ using DJGPP tools.
+
+ A precompiled binary of the MSDOS port of GNU Make is available as part
+ of DJGPP; see the WWW page https://www.delorie.com/djgpp/ for more
+ information.
+
+ The Cygwin project maintains its own port of GNU Make. That port may have
+ patches which are not present in this version. If you are using Cygwin
+ you should use their version of GNU Make, and if you have questions about
+ it you should start by asking on those mailing lists and forums.
+
+Please note there are two _separate_ ports of GNU Make for Microsoft
+systems: a native Windows tool built with (for example) MSVC or Cygwin,
+and a DOS-based tool built with DJGPP. Please be sure you are looking
+at the right README!
+
+
+-------------------------------------------------------------------------------
+Copyright (C) 1988-2022 Free Software Foundation, Inc.
+This file is part of GNU Make.
+
+GNU Make is free software; you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <https://www.gnu.org/licenses/>.