zig build docs fails due to main signature
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- zig
- Domain
- build-system
Research direction
Start with the failing zig build docs command and the reported call at zig-pkg/mz_core-0.0.1-ELsvtMWWBQA6JLEbf1TSkxfPNjS5Xably4kU5XBXw1d1/src/microzig.zig:197; the diagnostic points to a changed main signature in Zig's test runner. Trace how the docs build compiles the blinky test for thumb-freestanding-eabi, then rerun the docs command to verify it succeeds.
Written by the indexing model from the issue text.
Description
Hello, when I added the docs step in my build.zig and run zig build docs to emit docs, it just print this:
docs
└─ install generated/
└─ compile test blinky small thumb-freestanding-eabi 1 errors
zig-pkg/mz_core-0.0.1-ELsvtMWWBQA6JLEbf1TSkxfPNjS5Xably4kU5XBXw1d1/src/microzig.zig:197:9: error: expected 1 argument(s), found 0
main();
^~~~
/zig/p/N-V-__8AACu_OBbt4a3QStxJWfpJ-wtN9KJk2cpqbz7OSqNx/lib/compiler/test_runner.zig:36:5: note: function declared here
pub fn main(init: std.process.Init.Minimal) void {
~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
referenced by:
export_startup [inlined]: zig-pkg/mz_core-0.0.1-ELsvtMWWBQA6JLEbf1TSkxfPNjS5Xably4kU5XBXw1d1/src/microzig.zig:156:14
comptime: src/main.zig:19:32
error: 1 compilation errors
Build Summary: 34/37 steps succeeded (1 failed)
docs transitive failure
└─ install generated/ transitive failure
└─ compile test blinky small thumb-freestanding-eabi 1 errors
- Dominant language
- Zig
- Stars
- 2.3k
- Forks
- 198
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 37
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ZigEmbeddedGroup/microzig
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
ZigEmbeddedGroup/microzig#1086 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 69/100
ZigEmbeddedGroup/microzig#1085 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
ZigEmbeddedGroup/microzig#1059 · 1 comment ·
Maintainers usually reply within 1 day
-
regz: AVR peripherals generated at address 0 when the register-group name matches the module (ATDF)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 4/5 3-5 days Newbie friendliness 48/100
ZigEmbeddedGroup/microzig#1072 ·
Maintainers usually reply within 1 day
-
AVR (ATmega328P): UART/SPI HAL, drivers.zig, and nRF24L01+ driver (Emakefun RF-Nano V3.0)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
ZigEmbeddedGroup/microzig#1069 · 3 comments ·
Maintainers usually reply within 1 day
All issues in ZigEmbeddedGroup/microzig
Similar issues
-
dependencies effort:S priority:P2
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
app:web meta:ops
Difficulty 2/5 Half a day Newbie friendliness 78/100
osu-tournament-rating/otr#1113 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
category:port-update
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 2 days
-
bug cli libc sev-3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100