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

[WiP] gtk-doc: patch the on-line DocBook XSL paths to the local #56504

Closed
wants to merge 1 commit into from

Conversation

@amiloradovsky
Copy link
Contributor

@amiloradovsky amiloradovsky commented Feb 28, 2019

This is what's done in Guix, so gtkdoc-mkhtml would in no case even try to reach for the Internet.
Also removed dblatex, because it was never enabled and causes circular dependencies if it is.
The --disable-scrollkeeper configure flag isn't recognized by now.
And doCheck should be left alone, as long as the tests pass.

Motivation for this change

Cleaning up, robustness.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

The [WiP] tag is because I couldn't test the impact on the other packages due to the limits of my hardware and Internet connection, and also because much of those packages fail for the deprecation warnings, not sure what that means.

This is what's done in Guix,
so `gtkdoc-mkhtml` would in no case even try to reach for the Internet.
Also removed `dblatex`,
because it was never enabled and causes circular dependencies if it is.
The `--disable-scrollkeeper` configure flag isn't recognized by now.
And `doCheck` should be left alone, as long as the tests pass.
@jtojnar
Copy link
Contributor

@jtojnar jtojnar commented May 1, 2019

The URI is, in the first place, an identifier of the stylesheet; the method the stylesheet will be obtained is independent of this. The primary source for locating the resources is the XML catalog; the fact that the URI can be used as a web URL is secondary and should not bother us – we, as packagers, are responsible for making the proper catalogs available.

I like the idea of limiting the scope where docbook-xsl is available to gtk-doc. In nixpkgs, sometimes the runtime dependencies of build tools are made available through dependencies of the depending package. This is usually done when the dependency is only used for a specific subsystem of the build tool (e.g. PDF generation) and we do not want to increase the closure of the tool for people who only need HTML export. However, since DocBook support will almost always be used, adding the stylesheet as a direct dependency to gtk-doc makes sense.

I am not very fond of patching over the URI with store path directly, though. I would rather rely on the catalogs still (perhaps using wrapProgram). The path you used is no longer the correct one.

@Infinisil
Copy link
Member

@Infinisil Infinisil commented Jan 23, 2020

Status on this? If there's no interest anymore we should close this

@stale
Copy link

@stale stale bot commented Jul 21, 2020

Hello, I'm a bot and I thank you in the name of the community for your contributions.

Nixpkgs is a busy repository, and unfortunately sometimes PRs get left behind for too long. Nevertheless, we'd like to help committers reach the PRs that are still important. This PR has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

If this is still important to you and you'd like to remove the stale label, we ask that you leave a comment. Your comment can be as simple as "still important to me". But there's a bit more you can do:

If you received an approval by an unprivileged maintainer and you are just waiting for a merge, you can @ mention someone with merge permissions and ask them to help. You might be able to find someone relevant by using Git blame on the relevant files, or via GitHub's web interface. You can see if someone's a member of the nixpkgs-committers team, by hovering with the mouse over their username on the web interface, or by searching them directly on the list.

If your PR wasn't reviewed at all, it might help to find someone who's perhaps a user of the package or module you are changing, or alternatively, ask once more for a review by the maintainer of the package/module this is about. If you don't know any, you can use Git blame on the relevant files, or GitHub's web interface to find someone who touched the relevant files in the past.

If your PR has had reviews and nevertheless got stale, make sure you've responded to all of the reviewer's requests / questions. Usually when PR authors show responsibility and dedication, reviewers (privileged or not) show dedication as well. If you've pushed a change, it's possible the reviewer wasn't notified about your push via email, so you can always officially request them for a review, or just @ mention them and say you've addressed their comments.

Lastly, you can always ask for help at our Discourse Forum, or more specifically, at this thread or at #nixos' IRC channel.

@stale stale bot added the 2.status: stale label Jul 21, 2020
@Infinisil
Copy link
Member

@Infinisil Infinisil commented Jul 24, 2020

Closing due to inactivity

@Infinisil Infinisil closed this Jul 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.