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/builders/packages/xorg: Convert to CommonMark. #105481

Merged
merged 4 commits into from Dec 1, 2020
Merged

doc/builders/packages/xorg: Convert to CommonMark. #105481

merged 4 commits into from Dec 1, 2020

Conversation

MostAwesomeDude
Copy link
Contributor

Motivation for this change

Fulfilling #105265.

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.

ryantm
ryantm requested changes Dec 1, 2020
View reviewed changes
doc/builders/packages/xorg.section.md Outdated Show resolved Hide resolved
doc/builders/packages/xorg.section.md Outdated Show resolved Hide resolved
@MostAwesomeDude
doc/builders/packages/xorg: Convert to CommonMark.
e0fbc4d 
I had to pick 7.4 or 7.5. I picked 7.4 for now.
@MostAwesomeDude
doc/builders/packages/xorg: Acknowledge the retired katamari.
fc0f32e 
I tested the shell snippets shown here; they work. Note that, because
they're intended for copy-and-paste, I did *not* make them into
ShellSessions with prompts. But that's something I can do if desired.
@MostAwesomeDude
doc/builders/packages/xorg: Fix pasto.
65fe254 
I did double-check that the fixed version does what we would want. In
either case, the katamari script is mostly of historical value, and
there's nothing to change in pkgs.
@MostAwesomeDude
doc/builders/packages/xorg: Use ShellSession for shell.
874e358 
I was worried, but the HTML output can still be copy-and-pasted, so it's
not a problem.
@MostAwesomeDude
Copy link
Contributor Author

Addressed review feedback and also rebased to fix merge conflicts. Thanks for your hard work.

@ryantm ryantm merged commit 1810623 into NixOS:master Dec 1, 2020
@MostAwesomeDude MostAwesomeDude deleted the docs-commonmark-xorg branch December 2, 2020 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ryantm ryantm Awaiting requested review from ryantm

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
@MostAwesomeDude @ryantm