NixOS / NixOS/nix.dev

Please write a proper guide on using buildFHSEnv as some binaries only work with that (not all can be patched)

Open
#1,168 0 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

guide guide (2)
Dominant language
Nix
Stars
4k
Forks
339
Avg merge
2d 11h
Merged PRs (30d)
7

Description

Learning goals

Describe when and when not to use buildFHSEnv for official contributions, but also general guide on how to use it and why it is considered a "shortcut" most times in the Nix eco system.

Prerequisites
This is more a standalone, so maybe more in the guides section?

Outline

Mainly just the use of FHSEnv in packaging or patching software to get working. How to just get unique software working (that is not already packaged in nixpkgs)

Prior art

https://discourse.nixos.org/t/trying-to-contribute-to-nixpkgs-but-only-buildfhsenv-works-for-binary/36579

Willing to help?

Sure, just ping me if you need me to proof read.

Priorities

Add 👍 to issues you find important.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Discourse discussion and the nix.dev guide on writing a tutorial. Define the guide's scope around when and when not to use buildFHSEnv, how it supports packaging or patching binaries, and why it is often considered a shortcut. Done means a published standalone guide covering those topics and explaining how to get unpackaged software working.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.