mirrors/nixpkgs
1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-17 11:10:03 +00:00
Code Issues Wiki Activity
nixpkgs/doc/preface.chapter.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

51 lines
3 KiB
Markdown
Raw Permalink Normal View History

doc: explicit Markdown anchors for top-level headings; remove metadata I used the existing anchors generated by Docbook, so the anchor part should be a no-op. This could be useful depending on the infrastructure we choose to use, and it is better to be explicit than rely on Docbook's id generating algorithms. I got rid of the metadata segments of the Markdown files, because they are outdated, inaccurate, and could make people less willing to change them without speaking with the author.
2021-01-01 17:45:43 +00:00
# Preface {#preface}
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
nixpkgs manual introduction: improve - make line wrapping more consistent (overlong lines) - don't stress the manual is *only* for contributors, as it does contain some user-guide parts, including the intro itself - since March our Hydra publishes binaries immediately, not waiting for channel update
2016-04-05 08:56:32 +01:00
The Nix Packages collection (Nixpkgs) is a set of thousands of packages for the
nixpkgs manual: various improvements in introduction - rename to preface to be inline with NixOS manual - refer to other manuals - use https - change example channel to 19.09
2019-10-28 10:40:40 +00:00
[Nix package manager](https://nixos.org/nix/), released under a
doc: remove mention of X11 license variant (#255081) The Nixpkgs license is pure MIT.
2023-09-14 17:08:25 +01:00
[permissive MIT license](https://github.com/NixOS/nixpkgs/blob/master/COPYING).
nixpkgs manual introduction: improve - make line wrapping more consistent (overlong lines) - don't stress the manual is *only* for contributors, as it does contain some user-guide parts, including the intro itself - since March our Hydra publishes binaries immediately, not waiting for channel update
2016-04-05 08:56:32 +01:00
Packages are available for several platforms, and can be used with the Nix
nixpkgs manual: various improvements in introduction - rename to preface to be inline with NixOS manual - refer to other manuals - use https - change example channel to 19.09
2019-10-28 10:40:40 +00:00
package manager on most GNU/Linux distributions as well as [NixOS](https://nixos.org/nixos).
nixpkgs manual introduction: improve - make line wrapping more consistent (overlong lines) - don't stress the manual is *only* for contributors, as it does contain some user-guide parts, including the intro itself - since March our Hydra publishes binaries immediately, not waiting for channel update
2016-04-05 08:56:32 +01:00
doc: Rename to Nixpkgs reference manual and state purpose For the time being, we're moving towards https://nix.dev/ containing all tutorials and guides. The Nixpkgs manual is reinforced to be a _reference_ manual. While it's not just reference for now, that's what the docs team is working towards. This commits rewrites the Nixpkgs manual introduction to reflect that and point to some more useful links. The contribution docs are updated similarly so it's not missed. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-12-05 02:33:53 +00:00
This document is the user [_reference_](https://nix.dev/contributing/documentation/diataxis#reference) manual for Nixpkgs.
It describes entire public interface of Nixpkgs in a concise and orderly manner, and all relevant behaviors, with examples and cross-references.
To discover other kinds of documentation:
- [nix.dev](https://nix.dev/): Tutorials and guides for getting things done with Nix
- [NixOS **Option Search**](https://search.nixos.org/options) and reference documentation
- [Nixpkgs **Package Search**](https://search.nixos.org/packages)
- [**NixOS** manual](https://nixos.org/manual/nixos/stable/): Reference documentation for the NixOS Linux distribution
- [`CONTRIBUTING.md`](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md): Contributing to Nixpkgs, including this manual
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
doc: prepare for commonmark We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
2021-06-05 20:22:45 +01:00
## Overview of Nixpkgs {#overview-of-nixpkgs}
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
Nix expressions describe how to build packages from source and are collected in
the [nixpkgs repository](https://github.com/NixOS/nixpkgs). Also included in the
nixpkgs manual introduction: improve - make line wrapping more consistent (overlong lines) - don't stress the manual is *only* for contributors, as it does contain some user-guide parts, including the intro itself - since March our Hydra publishes binaries immediately, not waiting for channel update
2016-04-05 08:56:32 +01:00
collection are Nix expressions for
nixpkgs manual: various improvements in introduction - rename to preface to be inline with NixOS manual - refer to other manuals - use https - change example channel to 19.09
2019-10-28 10:40:40 +00:00
[NixOS modules](https://nixos.org/nixos/manual/index.html#sec-writing-modules).
nixpkgs manual introduction: improve - make line wrapping more consistent (overlong lines) - don't stress the manual is *only* for contributors, as it does contain some user-guide parts, including the intro itself - since March our Hydra publishes binaries immediately, not waiting for channel update
2016-04-05 08:56:32 +01:00
With these expressions the Nix package manager can build binary packages.
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
Packages, including the Nix packages collection, are distributed through
nixpkgs manual: various improvements in introduction - rename to preface to be inline with NixOS manual - refer to other manuals - use https - change example channel to 19.09
2019-10-28 10:40:40 +00:00
[channels](https://nixos.org/nix/manual/#sec-channels). The collection is
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
distributed for users of Nix on non-NixOS distributions through the channel
doc: consistently use `nixpkgs-unstable` and "nixpkgs repository" Rename channel `nixpkgs` to `nixpkgs-unstable`. Based on the [repo branches](https://github.com/NixOS/nixpkgs/branches) and [channel status](https://status.nixos.org) I don't believe there is a `nixpkgs` channel. This confused me as a Nixpkgs beginner. Rename to `nixpkgs-unstable`, which does exist. Refer to "nixpkgs repository" consitently. Make the capitalization and "code quoting" consistent when referring to the repository itself.
2024-01-26 20:30:35 +00:00
`nixpkgs-unstable`. Users of NixOS generally use one of the `nixos-*` channels,
e.g. `nixos-22.11`, which includes all packages and modules for the stable NixOS
updating stable nixos version in preface.
2023-01-05 22:24:19 +00:00
22.11. Stable NixOS releases are generally only given
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
security updates. More up to date packages and modules are available via the
`nixos-unstable` channel.
doc: consistently use `nixpkgs-unstable` and "nixpkgs repository" Rename channel `nixpkgs` to `nixpkgs-unstable`. Based on the [repo branches](https://github.com/NixOS/nixpkgs/branches) and [channel status](https://status.nixos.org) I don't believe there is a `nixpkgs` channel. This confused me as a Nixpkgs beginner. Rename to `nixpkgs-unstable`, which does exist. Refer to "nixpkgs repository" consitently. Make the capitalization and "code quoting" consistent when referring to the repository itself.
2024-01-26 20:30:35 +00:00
Both `nixos-unstable` and `nixpkgs-unstable` follow the `master` branch of the
nixpkgs repository, although both do lag the `master` branch by generally
nixpkgs manual preface: change howoldis link to status page link
2020-04-03 02:52:44 +01:00
[a couple of days](https://status.nixos.org/). Updates to a channel are
nixpkgs manual introduction: improve - make line wrapping more consistent (overlong lines) - don't stress the manual is *only* for contributors, as it does contain some user-guide parts, including the intro itself - since March our Hydra publishes binaries immediately, not waiting for channel update
2016-04-05 08:56:32 +01:00
distributed as soon as all tests for that channel pass, e.g.
nixpkgs manual: various improvements in introduction - rename to preface to be inline with NixOS manual - refer to other manuals - use https - change example channel to 19.09
2019-10-28 10:40:40 +00:00
[this table](https://hydra.nixos.org/job/nixpkgs/trunk/unstable#tabs-constituents)
doc: consistently use `nixpkgs-unstable` and "nixpkgs repository" Rename channel `nixpkgs` to `nixpkgs-unstable`. Based on the [repo branches](https://github.com/NixOS/nixpkgs/branches) and [channel status](https://status.nixos.org) I don't believe there is a `nixpkgs` channel. This confused me as a Nixpkgs beginner. Rename to `nixpkgs-unstable`, which does exist. Refer to "nixpkgs repository" consitently. Make the capitalization and "code quoting" consistent when referring to the repository itself.
2024-01-26 20:30:35 +00:00
shows the status of tests for the `nixpkgs-unstable` channel.
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
treewide: use https for nixos.org and hydra.nixos.org tarballs.nixos.org is omitted from the change because urls from there are always hashed and checked
2020-04-18 21:51:19 +01:00
The tests are conducted by a cluster called [Hydra](https://nixos.org/hydra/),
nixpkgs manual introduction: improve - make line wrapping more consistent (overlong lines) - don't stress the manual is *only* for contributors, as it does contain some user-guide parts, including the intro itself - since March our Hydra publishes binaries immediately, not waiting for channel update
2016-04-05 08:56:32 +01:00
which also builds binary packages from the Nix expressions in Nixpkgs for
`x86_64-linux`, `i686-linux` and `x86_64-darwin`.
The binaries are made available via a [binary cache](https://cache.nixos.org).
DOC: Overview of Nixpkgs/channels/Hydra/tests (close #11263) What I missed when I began using Nix and NixOS was a clear overview of how packages, channels, Hydra, the master branch and updates to channels relate to each other. I've noticed I am not the only one, given the amount of times these questions pop up. For now I propose to include this in the Nixpkgs manual, since this seems to be the best fit. However, I think it would be good to include this in either a new manual, i.e., a user manual, or an 'official' tutorial.
2015-11-25 16:13:44 +00:00
The current Nix expressions of the channels are available in the
doc: consistently use `nixpkgs-unstable` and "nixpkgs repository" Rename channel `nixpkgs` to `nixpkgs-unstable`. Based on the [repo branches](https://github.com/NixOS/nixpkgs/branches) and [channel status](https://status.nixos.org) I don't believe there is a `nixpkgs` channel. This confused me as a Nixpkgs beginner. Rename to `nixpkgs-unstable`, which does exist. Refer to "nixpkgs repository" consitently. Make the capitalization and "code quoting" consistent when referring to the repository itself.
2024-01-26 20:30:35 +00:00
[nixpkgs repository](https://github.com/NixOS/nixpkgs) in branches
updating stable nixos version in preface.
2023-01-05 22:24:19 +00:00
that correspond to the channel names (e.g. `nixos-22.11-small`).
Copy permalink