From 6f9c54bbd10c5a3db0cec31c570678e11a864344 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Mon, 24 Mar 2025 18:53:52 +0000 Subject: [PATCH] docs(reference/nix-daemon): fix some links [se-StorePathName] was missing in the footnotes, and links to sets were wrong. Also rename serialization.md to types.md to match the title. Change-Id: I8e602df1958cf5354c6fd3a5c16cbe859a0549b9 Reviewed-on: https://cl.snix.dev/c/snix/+/30275 Autosubmit: Florian Klink Tested-by: besadii Reviewed-by: Brian Olsen --- .../nix-daemon-protocol/handshake.md | 4 +- .../reference/nix-daemon-protocol/logging.md | 22 +++--- .../nix-daemon-protocol/operations.md | 67 ++++++++++--------- .../{serialization.md => types.md} | 2 +- 4 files changed, 48 insertions(+), 47 deletions(-) rename web/content/docs/reference/nix-daemon-protocol/{serialization.md => types.md} (99%) diff --git a/web/content/docs/reference/nix-daemon-protocol/handshake.md b/web/content/docs/reference/nix-daemon-protocol/handshake.md index d541530ff..4d607fc85 100644 --- a/web/content/docs/reference/nix-daemon-protocol/handshake.md +++ b/web/content/docs/reference/nix-daemon-protocol/handshake.md @@ -45,5 +45,5 @@ parameters. - send logs - [operation]({{< relref "operations.md" >}}) :: [Int](#se-Int) -[se-Int]: {{< relref "serialization.md" >}}#int -[se-Bool]: {{< relref "serialization.md" >}}#bool +[se-Int]: {{< relref "types.md" >}}#int +[se-Bool]: {{< relref "types.md" >}}#bool diff --git a/web/content/docs/reference/nix-daemon-protocol/logging.md b/web/content/docs/reference/nix-daemon-protocol/logging.md index 8243a7c44..1a205a369 100644 --- a/web/content/docs/reference/nix-daemon-protocol/logging.md +++ b/web/content/docs/reference/nix-daemon-protocol/logging.md @@ -122,14 +122,14 @@ the protocol and this message would have been sent it is instead ignored. -[se-UInt64]: ./serialization.md#uint64 -[se-Int]: ./serialization.md#int -[se-Size]: ./serialization.md#size -[se-Verbosity]: ./serialization.md#verbosity -[se-ActivityType]: ./serialization.md#activitytype -[se-ResultType]: ./serialization.md#resulttype -[se-Bytes]: ./serialization.md#bytes -[se-String]: ./serialization.md#string -[se-List]: ./serialization.md#list-of-x -[se-Error]: ./serialization.md#error -[se-Field]: ./serialization.md#field +[se-UInt64]: {{< relref "types.md" >}}#uint64 +[se-Int]: {{< relref "types.md" >}}#int +[se-Size]: {{< relref "types.md" >}}#size +[se-Verbosity]: {{< relref "types.md" >}}#verbosity +[se-ActivityType]: {{< relref "types.md" >}}#activitytype +[se-ResultType]: {{< relref "types.md" >}}#resulttype +[se-Bytes]: {{< relref "types.md" >}}#bytes +[se-String]: {{< relref "types.md" >}}#string +[se-List]: {{< relref "types.md" >}}#list-of-x +[se-Error]: {{< relref "types.md" >}}#error +[se-Field]: {{< relref "types.md" >}}#field diff --git a/web/content/docs/reference/nix-daemon-protocol/operations.md b/web/content/docs/reference/nix-daemon-protocol/operations.md index 7a4090cfc..174910822 100644 --- a/web/content/docs/reference/nix-daemon-protocol/operations.md +++ b/web/content/docs/reference/nix-daemon-protocol/operations.md @@ -881,36 +881,37 @@ gcRoot :: [Path][se-Path] -[se-Int]: {{< relref "serialization.md" >}}#int -[se-UInt8]: {{< relref "serialization.md" >}}#uint8 -[se-UInt64]: {{< relref "serialization.md" >}}#uint64 -[se-Bool]: {{< relref "serialization.md" >}}#bool -[se-Bool64]: {{< relref "serialization.md" >}}#bool64 -[se-Time]: {{< relref "serialization.md" >}}#time -[se-FileIngestionMethod]: {{< relref "serialization.md" >}}#fileingestionmethod -[se-BuildMode]: {{< relref "serialization.md" >}}#buildmode -[se-Verbosity]: {{< relref "serialization.md" >}}#verbosity -[se-GCAction]: {{< relref "serialization.md" >}}#gcaction -[se-Bytes]: {{< relref "serialization.md" >}}#bytes -[se-String]: {{< relref "serialization.md" >}}#string -[se-StorePath]: {{< relref "serialization.md" >}}#storepath -[se-BaseStorePath]: {{< relref "serialization.md" >}}#basestorepath -[se-OptStorePath]: {{< relref "serialization.md" >}}#optstorepath -[se-ContentAddressMethodWithAlgo]: {{< relref "serialization.md" >}}#contentaddressmethodwithalgo -[se-OptContentAddress]: {{< relref "serialization.md" >}}#optcontentaddress -[se-DerivedPath]: {{< relref "serialization.md" >}}#derivedpath -[se-DrvOutput]: {{< relref "serialization.md" >}}#drvoutput -[se-Realisation]: {{< relref "serialization.md" >}}#realisation -[se-List]: {{< relref "serialization.md" >}}#list-of-x -[se-Set]: {{< relref "serialization.md" >}}#set-of-x -[se-Map]: {{< relref "serialization.md" >}}#map-of-x-to-y -[se-SubstitutablePathInfo]: {{< relref "serialization.md" >}}#substitutablepathinfo -[se-ValidPathInfo]: {{< relref "serialization.md" >}}#validpathinfo -[se-UnkeyedValidPathInfo]: {{< relref "serialization.md" >}}#unkeyedvalidpathinfo -[se-BuildResult]: {{< relref "serialization.md" >}}#buildmode -[se-KeyedBuildResult]: {{< relref "serialization.md" >}}#keyedbuildresult -[se-BasicDerivation]: {{< relref "serialization.md" >}}#basicderivation -[se-Framed]: {{< relref "serialization.md" >}}#framed -[se-AddMultipleToStore]: {{< relref "serialization.md" >}}#addmultipletostore-format -[se-ExportFormat]: {{< relref "serialization.md" >}}#export-path-format -[se-ImportPaths]: {{< relref "serialization.md" >}}#import-paths-format +[se-Int]: {{< relref "types.md" >}}#int +[se-UInt8]: {{< relref "types.md" >}}#uint8 +[se-UInt64]: {{< relref "types.md" >}}#uint64 +[se-Bool]: {{< relref "types.md" >}}#bool +[se-Bool64]: {{< relref "types.md" >}}#bool64 +[se-Time]: {{< relref "types.md" >}}#time +[se-FileIngestionMethod]: {{< relref "types.md" >}}#fileingestionmethod +[se-BuildMode]: {{< relref "types.md" >}}#buildmode +[se-Verbosity]: {{< relref "types.md" >}}#verbosity +[se-GCAction]: {{< relref "types.md" >}}#gcaction +[se-Bytes]: {{< relref "types.md" >}}#bytes +[se-String]: {{< relref "types.md" >}}#string +[se-StorePath]: {{< relref "types.md" >}}#storepath +[se-StorePathName]: {{< relref "types.md" >}}#storepathname +[se-BaseStorePath]: {{< relref "types.md" >}}#basestorepath +[se-OptStorePath]: {{< relref "types.md" >}}#optstorepath +[se-ContentAddressMethodWithAlgo]: {{< relref "types.md" >}}#contentaddressmethodwithalgo +[se-OptContentAddress]: {{< relref "types.md" >}}#optcontentaddress +[se-DerivedPath]: {{< relref "types.md" >}}#derivedpath +[se-DrvOutput]: {{< relref "types.md" >}}#drvoutput +[se-Realisation]: {{< relref "types.md" >}}#realisation +[se-List]: {{< relref "types.md" >}}#list-of-x +[se-Set]: {{< relref "types.md" >}}#set-of-x +[se-Map]: {{< relref "types.md" >}}#map-of-x-to-y +[se-SubstitutablePathInfo]: {{< relref "types.md" >}}#substitutablepathinfo +[se-ValidPathInfo]: {{< relref "types.md" >}}#validpathinfo +[se-UnkeyedValidPathInfo]: {{< relref "types.md" >}}#unkeyedvalidpathinfo +[se-BuildResult]: {{< relref "types.md" >}}#buildmode +[se-KeyedBuildResult]: {{< relref "types.md" >}}#keyedbuildresult +[se-BasicDerivation]: {{< relref "types.md" >}}#basicderivation +[se-Framed]: {{< relref "types.md" >}}#framed +[se-AddMultipleToStore]: {{< relref "types.md" >}}#addmultipletostore-format +[se-ExportFormat]: {{< relref "types.md" >}}#export-path-format +[se-ImportPaths]: {{< relref "types.md" >}}#import-paths-format diff --git a/web/content/docs/reference/nix-daemon-protocol/serialization.md b/web/content/docs/reference/nix-daemon-protocol/types.md similarity index 99% rename from web/content/docs/reference/nix-daemon-protocol/serialization.md rename to web/content/docs/reference/nix-daemon-protocol/types.md index 1d2155514..acc9619c0 100644 --- a/web/content/docs/reference/nix-daemon-protocol/serialization.md +++ b/web/content/docs/reference/nix-daemon-protocol/types.md @@ -317,7 +317,7 @@ Optional microseconds. ### SubstitutablePathInfo - deriver :: [OptStorePath](#optstorepath) -- references :: [Set][#set-of-x] of [StorePath](#storepath) +- references :: [Set](#set-of-x) of [StorePath](#storepath) - downloadSize :: [UInt64](#uint64) - narSize :: [UInt64](#uint64)