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

Manual page validation & generation is getting too slow #17261

Closed
Profpatsch opened this issue Jul 25, 2016 · 8 comments
Closed

Manual page validation & generation is getting too slow #17261

Profpatsch opened this issue Jul 25, 2016 · 8 comments
Labels
2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 8.has: documentation

Comments

@Profpatsch
Copy link
Member

Profpatsch commented Jul 25, 2016

With the current amount of configuration options the system rebuild process is approaching unbearably long times (10+s on my CPU from 2007).
With the amount of options growing exponentially this is going to be a serious problem quite soon.

I noticed xsltproc only uses one core for validation, so a big speedup is trivialy achievable. Sadly, xsltproc doesn’t support multithreading, but the manual generation should be easily paralellizable, by splitting the manual sections up in single derivations.
Maybe even one for each nix module file, that would also lead to the manual not completely rebuilding on every change to an option.

@domenkozar
Copy link
Member

Maybe using GNU parallel: https://www.gnu.org/software/parallel/parallel_tutorial.html

@edolstra
Copy link
Member

Generally changing the system configuration should not trigger a rebuild of the manual (so the manual/manpages will be fetched from the binary cache). If that does happen, it's usually caused by something like an option default depending on an option value.

@Profpatsch
Copy link
Member Author

Ah, this is for developers & patchers of course. Everyone who defines new options. I think the time of those people is extremely important as well, if not more (otherwise nobody likes to define new options anymore).

edolstra added a commit that referenced this issue Aug 1, 2016
This prevents gratuitous rebuilds of the manual every time the Git
revision changes.

Should help a bit with #17261.
@Profpatsch
Copy link
Member Author

I’d still like to see a solution to this, but wasn’t annoyed enough yet to start working on it.

@stale
Copy link

stale bot commented Jun 4, 2020

Thank you for your contributions.

This has been automatically marked as stale because it has had no activity for 180 days.

If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.

Here are suggestions that might help resolve this more quickly:

  1. Search for maintainers and people that previously touched the related code and @ mention them in a comment.
  2. Ask on the NixOS Discourse.
  3. Ask on the #nixos channel on irc.freenode.net.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 4, 2020
@Profpatsch
Copy link
Member Author

Will hopefully fixed by the new manual format in the near future.

@mbrgm
Copy link
Member

mbrgm commented Jun 8, 2020

@Profpatsch Could you provide a reference to that?

@Profpatsch
Copy link
Member Author

Profpatsch commented Jun 9, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 8.has: documentation
Projects
None yet
Development

No branches or pull requests

4 participants