Commit Graph

87 Commits

Author SHA1 Message Date
mergify[bot]
63c66c04be Merge pull request #13581 from NixOS/mergify/bp/2.28-maintenance/pr-13213
docs: fix duplicate anchor (backport #13213)
2025-07-31 03:09:47 +00:00
mergify[bot]
84f27a1329 Merge pull request #13645 from NixOS/mergify/bp/2.28-maintenance/pr-13382
Update docs (backport #13382)
2025-07-31 03:09:40 +00:00
mergify[bot]
5bd259b311 Merge pull request #13611 from NixOS/mergify/bp/2.28-maintenance/pr-13305
add documentation of tarball-ttl to nix-channel (backport #13305)
2025-07-31 02:59:37 +00:00
mergify[bot]
35e563b6bd Merge pull request #13634 from NixOS/mergify/bp/2.28-maintenance/pr-13361
Fix a minor typo (backport #13361)
2025-07-31 02:59:35 +00:00
mergify[bot]
ec920aea61 Merge pull request #13647 from NixOS/mergify/bp/2.28-maintenance/pr-13393
Fix typo: remove an extra word (backport #13393)
2025-07-31 02:59:32 +00:00
mergify[bot]
b2a2cf6934 Merge pull request #13585 from NixOS/mergify/bp/2.28-maintenance/pr-13232
docs: add another equivalence for the implication operator (backport #13232)
2025-07-30 19:32:14 +00:00
mergify[bot]
8db221bc50 Merge pull request #13578 from NixOS/mergify/bp/2.28-maintenance/pr-13184
Document more references concepts (backport #13184)
2025-07-30 19:29:46 +00:00
Egor Konovalov
01963be827 Fix link
Remove extra `realise`

(cherry picked from commit df21f24987)
2025-07-30 13:01:37 +00:00
Nikita Krasnov
66a5d4c31b Update docs
(cherry picked from commit 785f3867fd)
2025-07-30 13:00:35 +00:00
jayeshv
cac6cfe51e Fix a minor typo
(cherry picked from commit 699db04df3)
2025-07-30 12:54:33 +00:00
Jade Masker
aace3d91ac add reference to the tarball-ttl documentation
Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
(cherry picked from commit c0ceaa2d5d)
2025-07-30 12:35:31 +00:00
Jade Masker
ab3ad122db remove overly verbose mention of fetchTarball
Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
(cherry picked from commit 633d39109b)
2025-07-30 12:35:31 +00:00
Jade Lynn Masker
b320aa50fe add documentation of tarball-ttl to nix-channel
(cherry picked from commit 6badd21b6a)
2025-07-30 12:35:30 +00:00
Gwenn Le Bihan
7126d57220 docs: add another equivalence for the implication operator
the second equivalence, using a if-else expression, aligns much closer to how most humans think about implication, adding it might help some people :)

(cherry picked from commit 51151c2c28)
2025-07-30 12:00:02 +00:00
Robert Hensing
4a1e3ad48b doc: Render verbatim @docroot@ on contributing page
In rendered form:

```diff
-Add references to the manual using ..
+Add references to the manual using [links like this](@docroot@/example.md)
```

(cherry picked from commit 147a34c573)
2025-07-30 11:56:00 +00:00
Peder Bergebakken Sundt
1e371c4a49 docs: fix duplicate anchor
`#deriving-path-encoding` is defined in two places, I _think_ this is the correct one to change.

(cherry picked from commit 4c50cf798e)
2025-07-30 11:53:56 +00:00
John Ericson
0560581a48 Document more references concepts
(cherry picked from commit b287438476)
2025-07-30 11:40:09 +00:00
Sergei Zimmerman
08f7ddbee5 meson: Fix nix_system_cpu for MIPS and 32 bit ARM systems
Prior patches in 54dc5314e8
and 6db6190002 fixed the default
system double for i686 and ppc/ppc64. This also patch also covers
32 bit arm and mips. ARM cpu names are taken from host_machine.cpu()
for a lack of a better option, but host_machine.cpu_family() is
preferred, since that is supposed to be somewhat standard for cross
files. Endianness is handled correctly by looking at host_machine.endian().

This also updates the documentation to be up to date to how system cpu
is translated from the host_machine specification.

(cherry picked from commit 60d124b36e)
2025-07-26 23:29:28 +00:00
Peder Bergebakken Sundt
a7588b47f2 docs: remove lexical illusions detected with write-good
I made this this non-markdown aware tool somewhat behave with some cursed fd+pandoc invocations

(cherry picked from commit ea5302c4a2)
2025-05-16 15:56:25 +00:00
Peder Bergebakken Sundt
d1e397d2a5 docs: remove repeated "allowedReferences"
This is what write-good lints as a "lexical illusion"

(cherry picked from commit cb16cd707c)
2025-05-16 15:56:25 +00:00
Jörg Thalheim
58c84bcf8a docs/building: fix attribute for nix-cli-ccacheStdenv
(cherry picked from commit c12fd7b319)
2025-05-14 17:27:02 -04:00
Jörg Thalheim
f8984c4182 docs: update cross compilation section from autotools to meson
fixes https://github.com/NixOS/nix/issues/12934

Update doc/manual/source/development/building.md

Co-authored-by: Eelco Dolstra <edolstra@gmail.com>

Update doc/manual/source/development/building.md

Co-authored-by: John Ericson <git@JohnEricson.me>
(cherry picked from commit 723f2c7352)
2025-05-14 17:27:02 -04:00
Jörg Thalheim
8f5172d026 fix various typos in docs
(cherry picked from commit a70140b55a)
2025-05-14 17:26:55 -04:00
Sergei Zimmerman
b4bfe15559 docs: Fix miscellaneous typos and formatting issues
(cherry picked from commit 20a724d131)
2025-05-14 19:10:59 +00:00
Eelco Dolstra
b1a1f4bd2f Mention BLAKE3 in the Nix 2.27 release notes
(cherry picked from commit c0ed07755a)
2025-04-14 13:47:57 +00:00
Anthony Wang
9156550493 Fix typo in string context docs
(cherry picked from commit f64b8957c7)
2025-04-12 23:58:45 +00:00
Robert Hensing
1ca3ee1287 Edit rl-2.28 2025-04-02 23:44:30 +02:00
Robert Hensing
fea87a94e6 doc/rl-2.28: Add contributors 2025-04-02 23:02:27 +02:00
John Ericson
703f0fbe74 release notes: 2.28.0 2025-04-02 16:46:13 -04:00
mergify[bot]
b9ad90d447 Merge pull request #12874 from NixOS/mergify/bp/2.28-maintenance/pr-12677
Improve the documentation of store path (backport #12677)
2025-04-02 17:40:53 +00:00
mergify[bot]
8e94856239 Merge pull request #12875 from NixOS/mergify/bp/2.28-maintenance/pr-11672
doc: note that @-pattern is accessible in default values (backport #11672)
2025-04-02 17:02:05 +00:00
Valentin Gagarin
9fd8f5ef04 doc: note that function bindings are accessible in default values
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
(cherry picked from commit 9c3dd34cfe)
2025-04-02 15:45:31 +00:00
oldshensheep
ce8b1eb2c4 Improve the documentation of store path
# Conflicts:
#	doc/manual/source/protocols/store-path.md

(cherry picked from commit 355a923e81)
2025-04-02 15:44:26 +00:00
John Ericson
0c67777396 Expose the nix component in header include paths
For example, instead of doing

    #include "nix/store-config.hh"
    #include "nix/derived-path.hh"

Now do

    #include "nix/store/config.hh"
    #include "nix/store/derived-path.hh"

This was originally planned in the issue, and also recent requested by
Eelco.

Most of the change is purely mechanical. There is just one small
additional issue. See how, in the example above, we took this
opportunity to also turn `<comp>-config.hh` into `<comp>/config.hh`.
Well, there was already a `nix/util/config.{cc,hh}`. Even though there
is not a public configuration header for libutil (which also would be
called `nix/util/config.{cc,hh}`) that's still confusing, To avoid any
such confusion, we renamed that to `nix/util/configuration.{cc,hh}`.

Finally, note that the libflake headers already did this, so we didn't
need to do anything to them. We wouldn't want to mistakenly get
`nix/flake/flake/flake.hh`!

Progress on #7876

(cherry picked from commit cc24766fa6)
2025-04-02 11:37:17 -04:00
John Ericson
15658b259f Separate headers from source files
The short answer for why we need to do this is so we can consistently do
`#include "nix/..."`. Without this change, there are ways to still make
that work, but they are hacky, and they have downsides such as making it
harder to make sure headers from the wrong Nix library (e..g.
`libnixexpr` headers in `libnixutil`) aren't being used.

The C API alraedy used `nix_api_*`, so its headers are *not* put in
subdirectories accordingly.

Progress on #7876

We resisted doing this for a while because it would be annoying to not
have the header source file pairs close by / easy to change file
path/name from one to the other. But I am ameliorating that with
symlinks in the next commit.

(cherry picked from commit f3e1c47f47)
2025-03-31 18:04:04 -04:00
mergify[bot]
b4f13afc1a Merge pull request #12828 from NixOS/mergify/bp/2.28-maintenance/pr-12624
Improve the documentation of the store path protocol (backport #12624)
2025-03-31 20:23:05 +00:00
mergify[bot]
a0cfbb1a38 Merge pull request #12825 from NixOS/mergify/bp/2.28-maintenance/pr-12618
Fix minor documentation typos (backport #12618)
2025-03-31 20:22:54 +00:00
Dmitry Bogatov
5ab3b9c616 Update doc/manual/source/protocols/store-path.md
Co-authored-by: John Ericson <git@JohnEricson.me>
(cherry picked from commit affd9bbab7)
2025-03-31 18:39:23 +00:00
Dmitry Bogatov
5805f9cb93 Improve the documentation of the store path protocol
1. Fix confusing wording that might imply unnecessary double-hashing.
2. Add references to specifics of base-32 encoding.
3. Fix incorrect description that sha256 hash of `fingerprint` is
   truncated. "Truncated" is actual wording used in Nix theses, but it has
   unusual meaning, that is better conveyed by word "compressed", which is
   used by the reference C++ implementation.
4. Clarify details of base16 encoding.

(cherry picked from commit a0facb2aba)
2025-03-31 18:39:22 +00:00
Farid Zakaria
12825ab972 Fix minor documentation typos
Was reading the store chapter and came across a few small typos
and edits.

(cherry picked from commit 33493b9ead)
2025-03-31 18:37:17 +00:00
John Ericson
3e2f4891c4 Advanced attributes organize
This is supposed to firstly improve the docs as they are, and secondly
hint at how the core conceptual information ought to be moved to the
store derivation section of the manual.

Co-authored-by: Jörg Thalheim <Mic92@users.noreply.github.com>
(cherry picked from commit 637aa0944d)
2025-03-31 18:31:12 +00:00
Eelco Dolstra
d000f5943a rl-2.27.md: Fix GitHub links
https://discourse.nixos.org/t/nix-2-27-0-released/62003/2?u=edolstra
(cherry picked from commit be5a455a1a)
2025-03-21 19:48:51 +00:00
Robert Hensing
8b9d401fe4 manual: Edit
(cherry picked from commit 1e00d14c29)
2025-03-03 22:13:09 +00:00
John Ericson
f278a631b0 Expand manual on derivation outputs
Note, this includes some text adapted from from Eelco's dissertation

(cherry picked from commit 2aa6e0f084)
2025-03-03 22:13:08 +00:00
Eelco Dolstra
ed294a31f5 Add more release notes 2025-02-26 22:23:44 +01:00
Eelco Dolstra
1d89507656 Fix date 2025-02-26 22:05:50 +01:00
Eelco Dolstra
c5a64aefac Add contributors 2025-02-26 22:01:24 +01:00
Eelco Dolstra
4a7bdddc8b Edit release notes 2025-02-26 21:59:41 +01:00
Eelco Dolstra
80020b684f release notes: 2.27.0 2025-02-26 21:57:30 +01:00
Silvan Mosberger
c19914f1ab doc: Fix ccacheStdenvPackages typo 2025-02-18 23:23:10 +01:00