Skip to content

Add data attribute to provide additional files to m4 #19

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.

Sign up for GitHub

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

Open
mgred wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Add data attribute to provide additional files to m4 #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
217adfa
Add `data` attribute to provide additional files to m4
mgred Aug 31, 2025
40bf2d1
update docs
mgred Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/rules_m4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Bazel rules for the m4 macro expander.
<pre>
load("@rules_m4//m4:m4.bzl", "m4")

m4(<a href="#m4-name">name</a>, <a href="#m4-srcs">srcs</a>, <a href="#m4-freeze_state">freeze_state</a>, <a href="#m4-m4_options">m4_options</a>, <a href="#m4-output">output</a>, <a href="#m4-reload_state">reload_state</a>)
m4(<a href="#m4-name">name</a>, <a href="#m4-srcs">srcs</a>, <a href="#m4-data">data</a>, <a href="#m4-freeze_state">freeze_state</a>, <a href="#m4-m4_options">m4_options</a>, <a href="#m4-output">output</a>, <a href="#m4-reload_state">reload_state</a>)
</pre>

Perform macro expansion to produce an output file.
Expand All @@ -38,6 +38,7 @@ m4(
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="m4-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
| <a id="m4-srcs"></a>srcs | List of source files to macro-expand. | <a href="https://bazel.build/concepts/labels">List of labels</a> | required | |
| <a id="m4-data"></a>data | List of additional files to m4. | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | `[]` |
| <a id="m4-freeze_state"></a>freeze_state | Optional output file for GNU M4 frozen state. Must have extension `.m4f`. | <a href="https://bazel.build/concepts/labels">Label</a>; <a href="https://bazel.build/reference/be/common-definitions#configurable-attributes">nonconfigurable</a> | optional | `None` |
| <a id="m4-m4_options"></a>m4_options | Additional options to pass to the `m4` command.<br><br>These will be added to the command args immediately before the source files. | List of strings | optional | `[]` |
| <a id="m4-output"></a>output | File to write output to. If unset, defaults to the rule name. | <a href="https://bazel.build/concepts/labels">Label</a>; <a href="https://bazel.build/reference/be/common-definitions#configurable-attributes">nonconfigurable</a> | optional | `None` |
Expand Down
8 changes: 7 additions & 1 deletion m4/rules/m4.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def _m4(ctx):
if stdout == None:
stdout = ctx.actions.declare_file(ctx.attr.name)

inputs = list(ctx.files.srcs)
inputs = list(ctx.files.srcs) + list(ctx.files.data)
outputs = [stdout]

args = ctx.actions.args()
Expand Down Expand Up @@ -110,6 +110,12 @@ m4(
name.
""",
),
"data": attr.label_list(
doc = "List of additional files to m4.",
default = [],
mandatory = False,
allow_files = True,
),
"freeze_state": attr.output(
doc = """Optional output file for GNU M4 frozen state. Must have
extension `.m4f`.
Expand Down