Skip to content

Commit ddc3fba

Browse files
committed
doc: fix "Nix Archive (NAR) format" specification
For executable files in NAR archives, the `executable` tag is followed by an empty string, which was not indicated correctly in the specification. Adding the empty string can be seen in `src/libutil/archive.cc:62`. Here is an example of a hexdump of a NAR archives where this empty string can be seen: ``` 00000730 65 6e 74 72 79 00 00 00 01 00 00 00 00 00 00 00 |entry...........| 00000740 28 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 |(...............| 00000750 6e 61 6d 65 00 00 00 00 10 00 00 00 00 00 00 00 |name............| 00000760 6c 69 62 6d 70 66 72 2e 73 6f 2e 36 2e 32 2e 31 |libmpfr.so.6.2.1| 00000770 04 00 00 00 00 00 00 00 6e 6f 64 65 00 00 00 00 |........node....| 00000780 01 00 00 00 00 00 00 00 28 00 00 00 00 00 00 00 |........(.......| 00000790 04 00 00 00 00 00 00 00 74 79 70 65 00 00 00 00 |........type....| 000007a0 07 00 00 00 00 00 00 00 72 65 67 75 6c 61 72 00 |........regular.| 000007b0 0a 00 00 00 00 00 00 00 65 78 65 63 75 74 61 62 |........executab| 000007c0 6c 65 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |le..............| 000007d0 08 00 00 00 00 00 00 00 63 6f 6e 74 65 6e 74 73 |........contents| 000007e0 a0 16 0c 00 00 00 00 00 7f 45 4c 46 02 01 01 00 |.........ELF....| 000007f0 00 00 00 00 00 00 00 00 03 00 3e 00 01 00 00 00 |..........>.....| 00000800 00 00 00 00 00 00 00 00 40 00 00 00 00 00 00 00 |........@.......| 00000810 e0 0e 0c 00 00 00 00 00 00 00 00 00 40 00 38 00 |[email protected].| 00000820 0b 00 40 00 1f 00 1e 00 01 00 00 00 04 00 00 00 |..@.............| 00000830 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 |................| ``` (taken from `09zrxnn4j5hjxqj93xvxrl1dpmq4cyajas3yf7a7y0i7h81m6bd4.nar`, available on `cache.nixos.org`)
1 parent af0ac14 commit ddc3fba

File tree

1 file changed

+2
-2
lines changed
  • doc/manual/source/protocols/nix-archive

1 file changed

+2
-2
lines changed

doc/manual/source/protocols/nix-archive/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ nar-obj-inner
2424
| str("type"), str("directory") directory
2525
;
2626
27-
regular = [ str("executable") ], str("contents"), str(contents);
27+
regular = [ str("executable"), str("") ], str("contents"), str(contents);
2828
2929
symlink = str("target"), str(target);
3030
@@ -52,4 +52,4 @@ The Nix Archive (NAR) format is also formally described using [Kaitai Struct](ht
5252
{{#include nar.ksy}}
5353
```
5454

55-
The source of the spec can be found [here](https://github.com/nixos/nix/blob/master/src/nix-manual/source/protocols/nix-archive/nar.ksy). Contributions and improvements to the spec are welcomed.
55+
The source of the spec can be found [here](https://github.com/nixos/nix/blob/master/src/nix-manual/source/protocols/nix-archive/nar.ksy). Contributions and improvements to the spec are welcomed.

0 commit comments

Comments
 (0)