Skip to content

Commit

Permalink
reword note on the definition of package
Browse files Browse the repository at this point in the history
  • Loading branch information
fricklerhandwerk committed Jan 30, 2024
1 parent 0e15707 commit fdc012f
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions source/tutorials/packaging-existing-software.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,15 @@ Going through all the steps carefully will take ca. 60 minutes.
## Your first package

:::{note}
A _package_ is a loosely defined Nixpkgs concept that refers to both a collection of files and other data, or a Nix derivation representing such a collection before it comes into being.
Packages have mostly standardised attributes and output layouts, allowing them to be discovered in searches and installed into environments alongside other packages.

For the purposes of this tutorial, "package" means something like "result of a derivation".
This is the artifact you or others will use, as a consequence of having "packaged existing software with Nix".
<!--
TODO: link to the Nix manual glossary entry once it's in a released build:
https://hydra.nixos.org/job/nix/master/build.x86_64-linux/latest/download/manual/glossary.html#package
-->
A _package_ is a loosely defined concept that refers to both a collection of files and other data, or a {term}`Nix expression` representing such a collection before it comes into being.
Packages in Nixpkgs have conventional, mostly standardised structure, allowing them to be discovered in searches and composed in environments alongside other packages.

For the purposes of this tutorial, "package" means: a Nix language function that will evaluate to a derivation.
It will enable you or others to produce an artifact for practical use, as a consequence of having "packaged existing software with Nix".
:::

To start, consider this skeleton derivation:
Expand Down

0 comments on commit fdc012f

Please sign in to comment.