[master] 062e71ebd build: Hide comments we don't need in Makefiles

Dridi Boukelmoune dridi.boukelmoune at gmail.com
Wed Jul 10 08:58:05 UTC 2024


commit 062e71ebdf6dd3735848355ae24b62db8e50887f
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date:   Wed Jul 10 10:45:27 2024 +0200

    build: Hide comments we don't need in Makefiles
    
    A comment starting with ## is omitted in Makefile.in and in the final
    Makefile.

diff --git a/lib/libvcc/vmodtool.py b/lib/libvcc/vmodtool.py
index c2fda1423..64e56d7f9 100755
--- a/lib/libvcc/vmodtool.py
+++ b/lib/libvcc/vmodtool.py
@@ -49,7 +49,7 @@ import sys
 import time
 
 AMBOILERPLATE = '''\
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_XXX_vcc ?= $(srcdir)/VCC
 
diff --git a/vmod/automake_boilerplate_blob.am b/vmod/automake_boilerplate_blob.am
index a90e66013..1d732af00 100644
--- a/vmod/automake_boilerplate_blob.am
+++ b/vmod/automake_boilerplate_blob.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_blob_vcc ?= $(srcdir)/vmod_blob.vcc
 
diff --git a/vmod/automake_boilerplate_cookie.am b/vmod/automake_boilerplate_cookie.am
index 18ba8f244..156bb4a72 100644
--- a/vmod/automake_boilerplate_cookie.am
+++ b/vmod/automake_boilerplate_cookie.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_cookie_vcc ?= $(srcdir)/vmod_cookie.vcc
 
diff --git a/vmod/automake_boilerplate_debug.am b/vmod/automake_boilerplate_debug.am
index 926ca74a4..abda2454e 100644
--- a/vmod/automake_boilerplate_debug.am
+++ b/vmod/automake_boilerplate_debug.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_debug_vcc ?= $(srcdir)/vmod_debug.vcc
 
diff --git a/vmod/automake_boilerplate_directors.am b/vmod/automake_boilerplate_directors.am
index 3a35af278..a2e5a6ce4 100644
--- a/vmod/automake_boilerplate_directors.am
+++ b/vmod/automake_boilerplate_directors.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_directors_vcc ?= $(srcdir)/vmod_directors.vcc
 
diff --git a/vmod/automake_boilerplate_h2.am b/vmod/automake_boilerplate_h2.am
index fac5fd517..30fa5e2b9 100644
--- a/vmod/automake_boilerplate_h2.am
+++ b/vmod/automake_boilerplate_h2.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_h2_vcc ?= $(srcdir)/vmod_h2.vcc
 
diff --git a/vmod/automake_boilerplate_proxy.am b/vmod/automake_boilerplate_proxy.am
index 7849b193f..480d82b83 100644
--- a/vmod/automake_boilerplate_proxy.am
+++ b/vmod/automake_boilerplate_proxy.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_proxy_vcc ?= $(srcdir)/vmod_proxy.vcc
 
diff --git a/vmod/automake_boilerplate_purge.am b/vmod/automake_boilerplate_purge.am
index 4f82e77cc..00656497e 100644
--- a/vmod/automake_boilerplate_purge.am
+++ b/vmod/automake_boilerplate_purge.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_purge_vcc ?= $(srcdir)/vmod_purge.vcc
 
diff --git a/vmod/automake_boilerplate_std.am b/vmod/automake_boilerplate_std.am
index 25c2d0797..738e97d9b 100644
--- a/vmod/automake_boilerplate_std.am
+++ b/vmod/automake_boilerplate_std.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_std_vcc ?= $(srcdir)/vmod_std.vcc
 
diff --git a/vmod/automake_boilerplate_unix.am b/vmod/automake_boilerplate_unix.am
index c7d47f074..ab5e982f7 100644
--- a/vmod/automake_boilerplate_unix.am
+++ b/vmod/automake_boilerplate_unix.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_unix_vcc ?= $(srcdir)/vmod_unix.vcc
 
diff --git a/vmod/automake_boilerplate_vtc.am b/vmod/automake_boilerplate_vtc.am
index 51d81c18f..0a2bd1228 100644
--- a/vmod/automake_boilerplate_vtc.am
+++ b/vmod/automake_boilerplate_vtc.am
@@ -1,4 +1,4 @@
-# Generated by vmodtool.py --boilerplate.
+## Generated by vmodtool.py --boilerplate.
 
 vmod_vtc_vcc ?= $(srcdir)/vmod_vtc.vcc
 
diff --git a/vsc.am b/vsc.am
index b3d7c4bdb..b9f269c4d 100644
--- a/vsc.am
+++ b/vsc.am
@@ -1,8 +1,8 @@
-# Generic rule to generate C code from VSC files. VSC files must be listed
-# in the $(VSC_SRC) variable. The $(VSCTOOL) variable must point to the
-# location of vsctool.py, normally set up by varnish.m4 at configure time.
-# The resulting $(VSC_GEN) variable must be added to $(BUILT_SOURCES). The
-# $(VSC_RST) variable references RST file names for manual pages includes.
+## Generic rule to generate C code from VSC files. VSC files must be listed
+## in the $(VSC_SRC) variable. The $(VSCTOOL) variable must point to the
+## location of vsctool.py, normally set up by varnish.m4 at configure time.
+## The resulting $(VSC_GEN) variable must be added to $(BUILT_SOURCES). The
+## $(VSC_RST) variable references RST file names for manual pages includes.
 
 VSC_GEN = $(VSC_SRC:.vsc=.c) $(VSC_SRC:.vsc=.h)
 
diff --git a/vtc.am b/vtc.am
index 0994f833f..db9837e48 100644
--- a/vtc.am
+++ b/vtc.am
@@ -1,12 +1,12 @@
-# This file helps set up a varnishtest execution without a traditional
-# pre-defined list of tests. Test cases are expected to be located in a
-# tests/ directory relative to the Makefile's source directory.
-#
-# When a difference is detected, a refresh is triggered by calling the
-# vtc-refresh-tests target that must be defined in the including Makefile.
-#
-# The current assumption is that all the tests for the Makefile are VTCs
-# and may be revisited if needed.
+## This file helps set up a varnishtest execution without a traditional
+## pre-defined list of tests. Test cases are expected to be located in a
+## tests/ directory relative to the Makefile's source directory.
+##
+## When a difference is detected, a refresh is triggered by calling the
+## vtc-refresh-tests target that must be defined in the including Makefile.
+##
+## The current assumption is that all the tests for the Makefile are VTCs
+## and may be revisited if needed.
 
 VTC_LOG_COMPILER = $(top_builddir)/bin/varnishtest/varnishtest -v -i
 TEST_EXTENSIONS = .vtc


More information about the varnish-commit mailing list