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

documention corrections #109663

Merged
merged 1 commit into from Jan 26, 2021
Merged

documention corrections #109663

merged 1 commit into from Jan 26, 2021

Conversation

Pamplemousse
Copy link
Member

@Pamplemousse Pamplemousse commented Jan 17, 2021 •
edited by roberth

Motivation for this change

Documentation about contributing to documentation has some errors.

PANDOC_LUA_FILTERS_DIR is set in makeFlags in doc/default.nix,
and needs to be explicitely passed to make when called manually.

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.

Signed-off-by: Pamplemousse xav.maso@gmail.com

@Pamplemousse Pamplemousse marked this pull request as draft January 17, 2021 19:22
@roberth
Copy link
Member

roberth commented Jan 19, 2021

This looks like a good incremental change. Any reason to keep it as draft and not merge?

@Pamplemousse Pamplemousse marked this pull request as ready for review January 20, 2021 01:16
@Pamplemousse
Copy link
Member Author

@roberth thanks for the ping!

I put it as draft because I was still learning about contributing to the documentation, and waited to see if there was more simple changes to add to this PR... and forgot about making it ready for review.

@Pamplemousse
documentation: correct documentation help
c803b23 
`PANDOC_LUA_FILTERS_DIR` is set in `makeFlags` in `doc/default.nix`,
and needs to be explicitely passed to `make` when called manually.

Signed-off-by: Pamplemousse <xav.maso@gmail.com>
@roberth
Copy link
Member

roberth commented Jan 26, 2021

This makes sense. Thank you!

@roberth roberth merged commit 1d0d9d2 into NixOS:master Jan 26, 2021
@Pamplemousse Pamplemousse deleted the documentation branch January 26, 2021 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonringer jonringer Awaiting requested review from jonringer

@roberth roberth Awaiting requested review from roberth

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

Successfully merging this pull request may close these issues.

None yet
2 participants
@Pamplemousse @roberth