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.

Sign up for GitHub

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

Jump to bottom

doc/firefox: correct manual generation #105955

Merged
merged 1 commit into from Dec 5, 2020
Merged

doc/firefox: correct manual generation #105955

merged 1 commit into from Dec 5, 2020

Conversation

terinjokes
Copy link
Contributor

@terinjokes terinjokes commented Dec 5, 2020 •
edited

Corrects the level of the "Troubleshooting" section, and adds an anchor
for Firefox.

Motivation for this change

I would like Hydra to build. Selfish I know.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • 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 nixpkgs-review --run "nixpkgs-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)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@vcunat
Copy link
Member

vcunat commented Dec 5, 2020

There seem to be more issues, though.

@terinjokes
Copy link
Contributor Author

I'm happy to try fixing more. I'm not sure how to try building the docs myself or see what other problems exist.

@vcunat
Copy link
Member

vcunat commented Dec 5, 2020

You can use

nix-build pkgs/top-level/release.nix -A manual

perhaps with added -Q --keep-failed.

On current master I see <section xml:id="troubleshooting"> generated even when the nesting is fixed. So far I don't know why.

@terinjokes
Copy link
Contributor Author

Ok. It's running the build now, thanks for the tip. I'll take a closer look.

@terinjokes
doc/firefox: correct manual generation
edfe388 
Corrects the level of the "Troubleshooting" section, and adds an anchor
for Firefox.
@terinjokes
Copy link
Contributor Author

This now builds locally.

@vcunat vcunat merged commit a7a8235 into NixOS:master Dec 5, 2020
@vcunat
Copy link
Member

vcunat commented Dec 5, 2020

Well yes. Hopefully this won't happen often, so it isn't worth the work to search for the more general cause and solution.

@terinjokes
Copy link
Contributor Author

This one stung, because I lost my Firefox extensions in the process :(

@jtojnar
Copy link
Contributor

jtojnar commented Dec 5, 2020

DocBook requires unique ids across the whole book. Pandoc will generate an id from the heading when one is not explicitly provided and since pandoc works on file level, it will gladly generate a duplicate id.

@terinjokes terinjokes deleted the patches/firefox-manual branch December 12, 2020 02:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vcunat vcunat vcunat approved these changes

Assignees
No one assigned
Labels
8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0 12. first-time contribution
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@terinjokes @vcunat @jtojnar @Janik-Haag