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: doctests fail with unhelpful error if line endings are CRLF #389

Open
Atomk opened this issue Sep 14, 2024 · 2 comments
Open

build: doctests fail with unhelpful error if line endings are CRLF #389

Atomk opened this issue Sep 14, 2024 · 2 comments

Comments

@Atomk
Copy link
Contributor

Atomk commented Sep 14, 2024

Zig version: 0.13.0
Os: Windows 10 64bit

Running zig build serve results in a lot of errors like this:

error: the following command exited with error code 1:
C:\Users\...\www.ziglang.org\.zig-cache\o\e937ebe0749345dff53c9daad9eabaa4\doctest.exe --zig C:\Users\...\zig\0.13.0\files\zig.exe --cache-root C:\Users\...\www.ziglang.org\.zig-cache -i C:\Users\...\www.ziglang.org\assets\zig-code\build-system\write-files\build.zig -o C:\Users\...\www.ziglang.org\.zig-cache\o\26f8aa00056207926fe891b2e0efb74c\build-system/write-files/build.zig
serve
└─ run server
   └─ website
      └─ install generated to learn\samples\index.html
         └─ run layout (learn\samples.smd)
            └─ Zine Index Content
               └─ run index-assets
                  └─ run doctest (build-system/conditional-compilation/build.zig) failure
error: missing manifest comment
Build summary
Build Summary: 60/222 steps succeeded; 68 failed (disable with --summary none)
serve transitive failure
└─ run server transitive failure
   └─ website transitive failure
      ├─ run update-assets transitive failure
      │  ├─ run layout (index.smd) transitive failure
      │  │  └─ Zine Index Content transitive failure
      │  │     └─ run index-assets transitive failure
      │  │        ├─ run doctest (index.zig) failure
      │  │        ├─ run doctest (samples/0-windows-msgbox.zig) failure
      │  │        ├─ run doctest (samples/1-memory-leak.zig) failure
      │  │        ├─ run doctest (samples/2-c-interop.zig) failure
      │  │        ├─ run doctest (samples/3-ziggzagg.zig) failure
      │  │        ├─ run doctest (samples/4-generic-type.zig) failure
      │  │        ├─ run doctest (samples/5-curl.zig) failure
      │  │        ├─ run doctest (build-system/1-simple-executable/build.zig) failure
      │  │        ├─ run doctest (build-system/1-simple-executable/hello.zig) failure
      │  │        ├─ run doctest (build-system/10-release/build.zig) failure
      │  │        ├─ run doctest (build-system/10-release/hello.zig) failure
      │  │        ├─ run doctest (build-system/10.5-system-tool/build.zig) failure
      │  │        ├─ run doctest (build-system/10.5-system-tool/src/main.zig) failure
      │  │        ├─ run doctest (build-system/11-zig-tool/build.zig) failure
      │  │        ├─ run doctest (build-system/11-zig-tool/src/main.zig) failure
      │  │        ├─ run doctest (build-system/12-embedfile/build.zig) failure
      │  │        ├─ run doctest (build-system/12-embedfile/src/main.zig) failure
      │  │        ├─ run doctest (build-system/13-import/build.zig) failure
      │  │        ├─ run doctest (build-system/13-import/src/main.zig) failure
      │  │        ├─ run doctest (build-system/13-import/tools/generate_struct.zig) failure
      │  │        ├─ run doctest (build-system/2-user-provided-options/build.zig) failure
      │  │        ├─ run doctest (build-system/2-user-provided-options/example.zig) failure
      │  │        ├─ run doctest (build-system/3-standard-config-options/build.zig) failure
      │  │        ├─ run doctest (build-system/3-standard-config-options/hello.zig) failure
      │  │        ├─ run doctest (build-system/conditional-compilation/build.zig) failure
      │  │        ├─ run doctest (build-system/conditional-compilation/app.zig) failure
      │  │        ├─ run doctest (build-system/convenience-run-step/build.zig) failure
      │  │        ├─ run doctest (build-system/convenience-run-step/hello.zig) failure
      │  │        ├─ run doctest (build-system/dynamic-library/build.zig) failure
      │  │        ├─ run doctest (build-system/mutate-source-files/build.zig) failure
      │  │        ├─ run doctest (build-system/mutate-source-files/tools/proto_gen.zig) failure
      │  │        ├─ run doctest (build-system/mutate-source-files/src/main.zig) failure
      │  │        ├─ run doctest (build-system/mutate-source-files/src/protocol.zig) failure
      │  │        ├─ run doctest (build-system/simple-static-library/build.zig) failure
      │  │        ├─ run doctest (build-system/simple-static-library/fizzbuzz.zig) failure
      │  │        ├─ run doctest (build-system/simple-static-library/demo.zig) failure
      │  │        ├─ run doctest (build-system/system-libraries/build.zig) failure
      │  │        ├─ run doctest (build-system/unit-testing/build.zig) failure
      │  │        ├─ run doctest (build-system/unit-testing/main.zig) failure
      │  │        ├─ run doctest (build-system/unit-testing-skip-foreign/build.zig) failure
      │  │        ├─ run doctest (build-system/write-files/build.zig) failure
      │  │        ├─ run doctest (build-system/write-files/src/main.zig) failure
      │  │        ├─ run doctest (features/1-integer-overflow.zig) failure
      │  │        ├─ run doctest (features/2-integer-overflow-runtime.zig) failure
      │  │        ├─ run doctest (features/3-undefined-behavior.zig) failure
      │  │        ├─ run doctest (features/4-hello.zig) failure
      │  │        ├─ run doctest (features/5-global-variables.zig) failure
      │  │        ├─ run doctest (features/6-null-to-ptr.zig) failure
      │  │        ├─ run doctest (features/7-optional-syntax.zig) failure
      │  │        ├─ run doctest (features/8-optional-orelse.zig) failure
      │  │        ├─ run doctest (features/9-optional-if.zig) failure
      │  │        ├─ run doctest (features/10-optional-while.zig) failure
      │  │        ├─ run doctest (features/11-errdefer.zig) failure
      │  │        ├─ run doctest (features/12-errors-as-values.zig) failure
      │  │        ├─ run doctest (features/13-errors-catch.zig) failure
      │  │        ├─ run doctest (features/14-errors-try.zig) failure
      │  │        ├─ run doctest (features/15-errors-switch.zig) failure
      │  │        ├─ run doctest (features/16-unreachable.zig) failure
      │  │        ├─ run doctest (features/17-stack-traces.zig) failure
      │  │        ├─ run doctest (features/18-types.zig) failure
      │  │        ├─ run doctest (features/19-generics.zig) failure
      │  │        ├─ run doctest (features/20-reflection.zig) failure
      │  │        ├─ run doctest (features/21-comptime.zig) failure
      │  │        ├─ run doctest (features/22-sine-wave.zig) failure
      │  │        ├─ run doctest (features/23-math-test.zig) failure
      │  │        ├─ run doctest (features/24-build.zig) failure
      │  │        ├─ run doctest (features/25-all-bases.zig) failure
      │  │        └─ run doctest (features/26-build.zig) failure
      │  ├─ run layout (devlog\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (devlog\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (zsf.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (download.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\announcing-zig-software-foundation.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\statement-regarding-zen-programming-language.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\fosdem-2021.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\zig-0.7.1.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\website-i18n-redesign.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\jakub-konka-hired-full-time\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\financials-update.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\goodbye-cpp\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\0.11.0-postponed-again.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\welcome-jacob-young.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\bounties-damage-open-source-projects.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\2024-financials.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\announcing-donor-bounties.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\first-donor-bounty.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\welcome-matthew-lugg.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\carmen-the-allocgator\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (news\migrate-to-self-hosting\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\why_zig_rust_d_cpp.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\tools.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\samples.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\overview.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\getting-started.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\build-system.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\index.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (zsf.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (download.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\why_zig_rust_d_cpp.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\tools.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\samples.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\overview.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  ├─ run layout (learn\getting-started.smd) transitive failure
      │  │  └─ Zine Index Content (+1 more reused dependencies)
      │  └─ run layout (learn\build-system.smd) transitive failure
      │     └─ Zine Index Content (+1 more reused dependencies)
      ├─ install generated to index.html transitive failure
      │  └─ run layout (index.smd) (+3 more reused dependencies)
      ├─ install generated to devlog\index.html transitive failure
      │  └─ run layout (devlog\index.smd) (+3 more reused dependencies)
      ├─ install generated to devlog/index.xml transitive failure
      │  └─ run layout (devlog\index.smd) (+3 more reused dependencies)
      ├─ install generated to learn\index.html transitive failure
      │  └─ run layout (learn\index.smd) (+3 more reused dependencies)
      ├─ install generated to news\index.html transitive failure
      │  └─ run layout (news\index.smd) (+3 more reused dependencies)
      ├─ install generated to news/index.xml transitive failure
      │  └─ run layout (news\index.smd) (+3 more reused dependencies)
      ├─ install generated to zsf\index.html transitive failure
      │  └─ run layout (zsf.smd) (+3 more reused dependencies)
      ├─ install generated to download\index.html transitive failure
      │  └─ run layout (download.smd) (+3 more reused dependencies)
      ├─ install generated to news\announcing-zig-software-foundation\index.html transitive failure
      │  └─ run layout (news\announcing-zig-software-foundation.smd) (+3 more reused dependencies)
      ├─ install generated to news/announcing-zig-software-foundation.html transitive failure
      │  └─ run layout (news\announcing-zig-software-foundation.smd) (+3 more reused dependencies)
      ├─ install generated to news\statement-regarding-zen-programming-language\index.html transitive failure
      │  └─ run layout (news\statement-regarding-zen-programming-language.smd) (+3 more reused dependencies)
      ├─ install generated to news/statement-regarding-zen-programming-language.html transitive failure
      │  └─ run layout (news\statement-regarding-zen-programming-language.smd) (+3 more reused dependencies)
      ├─ install generated to news\fosdem-2021\index.html transitive failure
      │  └─ run layout (news\fosdem-2021.smd) (+3 more reused dependencies)
      ├─ install generated to news/fosdem-2021.html transitive failure
      │  └─ run layout (news\fosdem-2021.smd) (+3 more reused dependencies)
      ├─ install generated to news\zig-0.7.1\index.html transitive failure
      │  └─ run layout (news\zig-0.7.1.smd) (+3 more reused dependencies)
      ├─ install generated to news/zig-0.7.1.html transitive failure
      │  └─ run layout (news\zig-0.7.1.smd) (+3 more reused dependencies)
      ├─ install generated to news\website-i18n-redesign\index.html transitive failure
      │  └─ run layout (news\website-i18n-redesign.smd) (+3 more reused dependencies)
      ├─ install generated to news\jakub-konka-hired-full-time\index.html transitive failure
      │  └─ run layout (news\jakub-konka-hired-full-time\index.smd) (+3 more reused dependencies)
      ├─ install generated to news\financials-update\index.html transitive failure
      │  └─ run layout (news\financials-update.smd) (+3 more reused dependencies)
      ├─ install generated to news\goodbye-cpp\index.html transitive failure
      │  └─ run layout (news\goodbye-cpp\index.smd) (+3 more reused dependencies)
      ├─ install generated to news\0.11.0-postponed-again\index.html transitive failure
      │  └─ run layout (news\0.11.0-postponed-again.smd) (+3 more reused dependencies)
      ├─ install generated to news/0.11.0-postponed-again.html transitive failure
      │  └─ run layout (news\0.11.0-postponed-again.smd) (+3 more reused dependencies)
      ├─ install generated to news\welcome-jacob-young\index.html transitive failure
      │  └─ run layout (news\welcome-jacob-young.smd) (+3 more reused dependencies)
      ├─ install generated to news/welcome-jacob-young.html transitive failure
      │  └─ run layout (news\welcome-jacob-young.smd) (+3 more reused dependencies)
      ├─ install generated to news\bounties-damage-open-source-projects\index.html transitive failure
      │  └─ run layout (news\bounties-damage-open-source-projects.smd) (+3 more reused dependencies)
      ├─ install generated to news\2024-financials\index.html transitive failure
      │  └─ run layout (news\2024-financials.smd) (+3 more reused dependencies)
      ├─ install generated to news\announcing-donor-bounties\index.html transitive failure
      │  └─ run layout (news\announcing-donor-bounties.smd) (+3 more reused dependencies)
      ├─ install generated to news\first-donor-bounty\index.html transitive failure
      │  └─ run layout (news\first-donor-bounty.smd) (+3 more reused dependencies)
      ├─ install generated to news\welcome-matthew-lugg\index.html transitive failure
      │  └─ run layout (news\welcome-matthew-lugg.smd) (+3 more reused dependencies)
      ├─ install generated to news\carmen-the-allocgator\index.html transitive failure
      │  └─ run layout (news\carmen-the-allocgator\index.smd) (+3 more reused dependencies)
      ├─ install generated to news\migrate-to-self-hosting\index.html transitive failure
      │  └─ run layout (news\migrate-to-self-hosting\index.smd) (+3 more reused dependencies)
      ├─ install generated to learn\why_zig_rust_d_cpp\index.html transitive failure
      │  └─ run layout (learn\why_zig_rust_d_cpp.smd) (+3 more reused dependencies)
      ├─ install generated to learn\tools\index.html transitive failure
      │  └─ run layout (learn\tools.smd) (+3 more reused dependencies)
      ├─ install generated to learn\samples\index.html transitive failure
      │  └─ run layout (learn\samples.smd) (+3 more reused dependencies)
      ├─ install generated to learn\overview\index.html transitive failure
      │  └─ run layout (learn\overview.smd) (+3 more reused dependencies)
      ├─ install generated to learn\getting-started\index.html transitive failure
      │  └─ run layout (learn\getting-started.smd) (+3 more reused dependencies)
      ├─ install generated to learn\build-system\index.html transitive failure
      │  └─ run layout (learn\build-system.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\index.html transitive failure
      │  └─ run layout (index.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\learn\index.html transitive failure
      │  └─ run layout (learn\index.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\zsf\index.html transitive failure
      │  └─ run layout (zsf.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\download\index.html transitive failure
      │  └─ run layout (download.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\learn\why_zig_rust_d_cpp\index.html transitive failure
      │  └─ run layout (learn\why_zig_rust_d_cpp.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\learn\tools\index.html transitive failure
      │  └─ run layout (learn\tools.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\learn\samples\index.html transitive failure
      │  └─ run layout (learn\samples.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\learn\overview\index.html transitive failure
      │  └─ run layout (learn\overview.smd) (+3 more reused dependencies)
      ├─ install generated to it-IT\learn\getting-started\index.html transitive failure
      │  └─ run layout (learn\getting-started.smd) (+3 more reused dependencies)
      └─ install generated to it-IT\learn\build-system\index.html transitive failure
         └─ run layout (learn\build-system.smd) (+3 more reused dependencies)
@Atomk Atomk changed the title Doctests failure whe building Doctests failure when building Sep 14, 2024
@kristoff-it
Copy link
Member

I suspect this is an issue that has to do with windows style line endings and https://github.com/ziglang/docgen not liking them.

I would suggest to configure your git client to not introduce \r into checked out files automatically, if you have the setting enabled, re-clone the website repo, and see if you still encounter this problem.

@Atomk
Copy link
Contributor Author

Atomk commented Sep 19, 2024

You guessed right, by correcting that I was able to get a step further, now the build fails for another reason so I will open a separate issue for that.

I'd like to leave this open since the error message given for the build failure is unrelated to the actual problem.

If you want to consider this an upstream issue I guess it can be moved to the Zine repo (I guess that tracker will be looked at much more often compared to the docgen repo).

@Atomk Atomk changed the title Doctests failure when building build: doctests fail with unhelpful error if line endings are CRLF Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants