Skip to content

docs: Mention more shell functions in stdenv#543787

Open
har7an wants to merge 1 commit into
NixOS:masterfrom
har7an:docs/stdenv-setup-sh
Open

docs: Mention more shell functions in stdenv#543787
har7an wants to merge 1 commit into
NixOS:masterfrom
har7an:docs/stdenv-setup-sh

Conversation

@har7an

@har7an har7an commented Jul 20, 2026

Copy link
Copy Markdown

which were previously defined but undocumented outside of setup.sh itself. Add back-references from the shell functions to the rendered upstream docs so anyone finding these from bash sources can enjoy a prettier and more integrated learning experience.

Things done

which were previously defined but undocumented outside of `setup.sh`
itself. Add back-references from the shell functions to the rendered
upstream docs so anyone finding these from bash sources can enjoy a
prettier and more integrated learning experience.
@har7an

har7an commented Jul 20, 2026

Copy link
Copy Markdown
Author

This is just a preview of the changes I had in mind, but I thought I'd post it here before investing more time.

Essentially I'd like to work through all of setup.sh and extract docs into the nixpkgs manual for every shell function that doesn't start with an underscore. I'd also add links to other sections where appropriate (e.g. for debugging via the custom exit hook).

Just let me know if there's interest in this. You can merge this MR and I'll get to work in (multiple?) follow-ups.

@nixpkgs-branch-check nixpkgs-branch-check Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The PR's base branch is set to master, but this PR causes 77557 rebuilds.
It is therefore considered a mass rebuild.
Please change the base branch to the right base branch for your changes (probably staging).

@nixpkgs-ci
nixpkgs-ci Bot requested review from a team, Ericson2314 and llakala July 20, 2026 09:56
@nixpkgs-ci nixpkgs-ci Bot added 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-darwin: 501+ This PR causes many rebuilds on Darwin and should normally target the staging branches. 10.rebuild-linux-stdenv This PR causes stdenv to rebuild on Linux and must target a staging branch. 10.rebuild-darwin-stdenv This PR causes stdenv to rebuild on Darwin and must target a staging branch. 10.rebuild-darwin: 5001+ This PR causes many rebuilds on Darwin and must target the staging branches. 10.rebuild-linux: 5001+ This PR causes many rebuilds on Linux and must target the staging branches. 12.first-time contribution This PR is the author's first one; please be gentle! 10.rebuild-nixos-tests This PR causes rebuilds for all NixOS tests and should normally target the staging branches. 6.topic: stdenv Standard environment labels Jul 20, 2026
@github-project-automation github-project-automation Bot moved this to In Progress in Stdenv Jul 20, 2026
@nixpkgs-ci nixpkgs-ci Bot added the 8.has: documentation This PR adds or changes documentation label Jul 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: stdenv Standard environment 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 501+ This PR causes many rebuilds on Darwin and should normally target the staging branches. 10.rebuild-darwin: 5001+ This PR causes many rebuilds on Darwin and must target the staging branches. 10.rebuild-darwin-stdenv This PR causes stdenv to rebuild on Darwin and must target a staging branch. 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. 10.rebuild-linux: 5001+ This PR causes many rebuilds on Linux and must target the staging branches. 10.rebuild-linux-stdenv This PR causes stdenv to rebuild on Linux and must target a staging branch. 10.rebuild-nixos-tests This PR causes rebuilds for all NixOS tests and should normally target the staging branches. 12.first-time contribution This PR is the author's first one; please be gentle!

Projects

Status: No status
Status: In Progress

Development

Successfully merging this pull request may close these issues.

1 participant