Skip to content

doc/stdenv/cross-compilation: convert to markdown#105364

Merged
jtojnar merged 1 commit intoNixOS:masterfrom
siraben:cross-doc-md
Dec 14, 2020
Merged

doc/stdenv/cross-compilation: convert to markdown#105364
jtojnar merged 1 commit intoNixOS:masterfrom
siraben:cross-doc-md

Conversation

@siraben
Copy link
Copy Markdown
Member

@siraben siraben commented Nov 29, 2020 •
edited
Loading

Motivation for this change

Part of RFC 72. Also, I wanted to do more substantial changes (in a future PR) to the cross-compilation docs but docbook is such a big barrier.

How to test:

$ cd docs
$ nix-build && nix-shell -p python3 --run 'python3 -m http.server --directory ./result/share/doc/nixpkgs'

Ping @ryantm

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.

@FRidh
Copy link
Copy Markdown
Member

FRidh commented Nov 29, 2020

Also, I wanted to do more substantial changes to the cross-compilation docs but docbook is such a big barrier.

Please do changes of content separately.

@siraben siraben force-pushed the cross-doc-md branch 2 times, most recently from 3452b2f to 9457153 Compare November 29, 2020 13:59
@ofborg ofborg bot added the 8.has: documentation This PR adds or changes documentation label Nov 29, 2020
@siraben
Copy link
Copy Markdown
Member Author

siraben commented Nov 29, 2020

Also, I wanted to do more substantial changes to the cross-compilation docs but docbook is such a big barrier.

Please do changes of content separately.

Yes, this PR just performs the conversion and some style fixes.

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels Nov 29, 2020
ryantm
ryantm requested changes Dec 3, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@ryantm ryantm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did a first pass. Since this is such a big section, I think it will require a few passes before we can get it dialed in. Thank you for tacking such a big and challenging section @siraben

jtojnar
jtojnar reviewed Dec 3, 2020
View reviewed changes
jtojnar
jtojnar reviewed Dec 3, 2020
View reviewed changes
@veprbl veprbl added the 6.topic: cross-compilation Building packages on a different platform than they will be used on label Dec 3, 2020
@siraben siraben requested review from jtojnar and ryantm December 4, 2020 11:48
@siraben siraben force-pushed the cross-doc-md branch 3 times, most recently from 6742c6d to 3b303a2 Compare December 4, 2020 11:59
ryantm
ryantm requested changes Dec 5, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@ryantm ryantm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your work and patience here. We're going to keep you in the loop about admonitions since this section has so many.

@siraben siraben mentioned this pull request Dec 8, 2020
Open
@siraben siraben force-pushed the cross-doc-md branch 2 times, most recently from 3605c8d to bf88107 Compare December 13, 2020 12:38
@siraben siraben requested a review from ryantm December 13, 2020 12:39
@siraben
Copy link
Copy Markdown
Member Author

siraben commented Dec 13, 2020

Thank you for your continual feedback, I've rebased on master and changed all the note sections to use the latest admonitions.

Additionally I ran a spellchecker and fixed some spelling mistakes: platfom -> platform, langauges -> languages, bootstraping -> bootstrapping, providess -> provides.

@siraben siraben mentioned this pull request Dec 13, 2020
Open
6 tasks
@jtojnar jtojnar merged commit f310317 into NixOS:master Dec 14, 2020
@jtojnar
Copy link
Copy Markdown
Member

jtojnar commented Dec 14, 2020

Looks good. Thanks.

@siraben siraben deleted the cross-doc-md branch December 14, 2020 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jtojnar jtojnar Awaiting requested review from jtojnar

@ryantm ryantm Awaiting requested review from ryantm

Assignees

No one assigned

Labels

6.topic: cross-compilation Building packages on a different platform than they will be used on 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@siraben @FRidh @jtojnar @ryantm @veprbl