Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: add autoconf auto-generation comment to input files #5251

Merged
merged 1 commit into from
Jul 31, 2022

Conversation

kmk3
Copy link
Collaborator

@kmk3 kmk3 commented Jul 16, 2022

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 #5140.

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.
@smitsohu smitsohu merged commit f986753 into netblue30:master Jul 31, 2022
@kmk3 kmk3 deleted the build-add-autoconf-comment branch August 1, 2022 12:20
kmk3 added a commit that referenced this pull request Aug 1, 2022
ChrysoliteAzalea pushed a commit to ChrysoliteAzalea/firejail that referenced this pull request Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done (on RELNOTES)
Development

Successfully merging this pull request may close these issues.

3 participants