add option to remove cwd() prefix from docgen output #25240
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In case of showing error output examples, you often have to scroll horizontally to see the interesting part of the output.
E.g. the shell output of running docgen on
langref.html.in
looks like this (Zig Language Reference, master):or like this (Zig Language Reference, 0.15.1):
In both cases the length of the path pushes the interesting information to the right, but certainly the start of that path provides no information relevant to for the person consulting the documentation.
This PR adds an option
--base-dir
todocgen
, which, if provided with a string argument, removes that argument from output of|code|
invoked Zig files. If the current directory is provided as argument (/home/ci/actions-runner/_work/zig-bootstrap/zig
resp./home/andy/dev/zig
in the above examples), this shortens the lines with filenames and so reduces (and often completely eliminates) the need for horizontal scrolling when viewing an example.build.zig
has been updated to providedocgen
with--base-dir <std.os.getcwd()>
(there did not seem to be an allocator available to dynamically allocate the buffer foros_cwd
, but maybe that is somehow available viastd.Build
, nor could I figure out how to provide anfs.Dir()
instance as.addFileArg()
argument)