diff mbox

[wwwdocs] Generated files and patches

Message ID 4C2347E7.7000705@embedded-brains.de
State New
Headers show

Commit Message

Sebastian Huber June 24, 2010, 11:56 a.m. UTC
This version also mentions the ChangeLog entry.

Comments

Ralf Wildenhues June 24, 2010, 6:24 p.m. UTC | #1
Hello Sebastian,

* Sebastian Huber wrote on Thu, Jun 24, 2010 at 01:56:23PM CEST:
> --- htdocs/contribute.html	4 Aug 2009 05:37:10 -0000	1.73
> +++ htdocs/contribute.html	24 Jun 2010 11:52:57 -0000
> @@ -235,7 +235,11 @@
>  If your version of diff does not support these options, then get the 
>  latest version of GNU diff.  Patches against current development (SVN trunk) 
>  are preferred to patches against releases, unless your patch is intended
> -as a candidate for the release branch.
> +as a candidate for the release branch.  The patch should not include generated
> +files like <code>configure.in</code>, <code>Makefile.in</code>, etc.  The
> +person who eventually commits the patch will take care of regenerating these
> +files with the appropriate tool.  The ChangeLog entry should mention the
> +regenerated files even if the patch does not contain that part.

In the GCC tree, configure.in, configure.ac, and Makefile.am files are
not generated.  configure files are always generated, Makefile.in files
are generated only in directories also containing a corresponding
Makefile.am file.  aclocal.m4 files which are present are always
generated in directories which also have a Makefile.am file, and
most of the time elsewhere too, but in case of doubt check its first
line.  Generated header input files are typically named config.h.in or
config.in, in case of doubt check their first line.

The GCC SVN tree contains other files which are generated by tools other
than autotools; for example, libjava/sources.am is generated by
libjava/scripts/makemake.tcl and is an input file for Makefile.in.

Cheers,
Ralf
diff mbox

Patch

Index: htdocs/contribute.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/contribute.html,v
retrieving revision 1.73
diff -u -r1.73 contribute.html
--- htdocs/contribute.html	4 Aug 2009 05:37:10 -0000	1.73
+++ htdocs/contribute.html	24 Jun 2010 11:52:57 -0000
@@ -235,7 +235,11 @@ 
 If your version of diff does not support these options, then get the 
 latest version of GNU diff.  Patches against current development (SVN trunk) 
 are preferred to patches against releases, unless your patch is intended
-as a candidate for the release branch.
+as a candidate for the release branch.  The patch should not include generated
+files like <code>configure.in</code>, <code>Makefile.in</code>, etc.  The
+person who eventually commits the patch will take care of regenerating these
+files with the appropriate tool.  The ChangeLog entry should mention the
+regenerated files even if the patch does not contain that part.
 </dd>
 
 </dl>