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

docs: avoid concurrency issues when generating images in parallel #4632

Merged
merged 3 commits into from
Oct 6, 2024

Conversation

tarikgraba
Copy link
Contributor

This should resolve issue #4631 when building the doc images in parallel.

I have removed the tidy target and I just delete log and aux file after building each pdf.

Copy link
Member

@KrystalDelusion KrystalDelusion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this! I always run make docs without a -j flag and have been meaning to look into it for ages but kept forgetting.

@@ -31,14 +31,13 @@ all_tex: $(TEX_FILES:.tex=.pdf) $(TEX_FILES:.tex=.svg)

%.pdf: %.tex
cd $(@D) && $(FAKETIME) pdflatex $(<F) --interaction=nonstopmode
rm -f $(*).aux $(*).log
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the rm was there because of how the docs website was being done and is no longer necessary. It would be better to leave this out entirely and just rely on the gitignore instead of removing the log files.

- remove the tidy target from the main target.
  * aux/log file are already excluded in a .gititgnore file
  * allow parallel generation as the tidy target imposes sequential build
@tarikgraba
Copy link
Contributor Author

I have reverted my previous commit and just removed the tidy target from the main target as I understand it is not needed any more (aux/log are ignored in docs/.gitignore)

Add `$(TARGETS)` for gen_examples and gen_images since they need the `yosys` executable.
Add guidelines source files as a prerequisite to docs/source/generated while we're at it.
@KrystalDelusion KrystalDelusion self-assigned this Oct 6, 2024
@KrystalDelusion KrystalDelusion merged commit 3534e6b into YosysHQ:main Oct 6, 2024
19 checks passed
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

Successfully merging this pull request may close these issues.

2 participants