Skip to content

Commit

Permalink
build: add autoconf auto-generation comment to input files
Browse files Browse the repository at this point in the history
To note on the output files that they are generated and to clarify how
they are generated.

From the manual of GNU Autoconf (version 2.69):

>  -- Variable: configure_input
>      A comment saying that the file was generated automatically by
>      'configure' and giving the name of the input file.  'AC_OUTPUT'
>      adds a comment line containing this variable to the top of every
>      makefile it creates.  For other files, you should reference this
>      variable in a comment at the top of each input file.  For
>      example, an input shell script should begin like this:
>
>           #!/bin/sh
>           # @configure_input@
>
>      The presence of that line also reminds people editing the file
>      that it needs to be processed by 'configure' in order to be used.

Resulting output on config.mk:

    # config.mk.  Generated from config.mk.in by configure.

Relates to netblue30#5140.
  • Loading branch information
kmk3 committed Jul 16, 2022
1 parent fbceab9 commit 8fc604f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
2 changes: 2 additions & 0 deletions config.mk.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @configure_input@
#
# Configure-time variable definitions and any other common definition that can
# be safely included by all makefiles.
#
Expand Down
1 change: 1 addition & 0 deletions config.sh.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# @configure_input@
NAME=@PACKAGE_NAME@
VERSION=@PACKAGE_VERSION@

0 comments on commit 8fc604f

Please sign in to comment.