doc: fix #96408 #96421
doc: fix #96408 #96421
Conversation
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/dockertools-imprecisions/8770/12 |
There was a problem hiding this comment.
In addition to the in-line comment, this PR does not respect the CONTRIBUTING guidelines.
The commit message is does not describe the change, referring only to the bug by number. There is no explanation as to the intent of the change.
| @@ -12,7 +12,7 @@ | |||
| <title>buildImage</title> | |||
|
|
|||
| <para> | |||
| This function is analogous to the <command>docker build</command> command, in that it can be used to build a Docker-compatible repository tarball containing a single image with one or multiple layers. As such, the result is suitable for being loaded in Docker with <command>docker load</command>. | |||
| This function is analogous to the <command>docker build</command> command, in that it can be used to build a Docker-compatible repository tarball containing a single image with one or multiple layers. As such, the <literal>./result/*</literal> is suitable for being loaded in Docker with <command>docker load</command>. | |||
There was a problem hiding this comment.
The output of a dockerTools is a docker image, a .tar.gz. Representing it as ./result/, which implies a directory, is wrong.
Additionally, a result is not necessarily a symlink as produced by nix-build. It is a store path, which can be used as inputs to other derivations too. The word result does not need further qualifications as it is just the word, with a well-known definition in the context of Nix builds.
What it might benefit from, if it is possible with the documentation tooling (current or incoming) is a link to a glossary of terms. Though this circles back to the concept that the reference documentation assumes a level of familiarity with Nix.
There was a problem hiding this comment.
The output of a dockerTools is a docker image, a .tar.gz. Representing it as ./result/, which implies a directory, is wrong.
I just learned this. This it's inconvenient - a path would be better: https://discourse.nixos.org/t/dockertools-result-not-a-folder/8771
Additionally, a result is not necessarily a symlink as produced by nix-build. It is a store path, which can be used as inputs to other derivations too. The word result does not need further qualifications as it is just the word, with a well-known definition in the context of Nix builds.
Then it must be italic.
There was a problem hiding this comment.
In the context of input for the docker load command, it can't be a result it must be one of the ./.../*.tar.gz (a single one).
There was a problem hiding this comment.
Or... the author didn't mean result but just plain English "result" - this is how I first read it.
|
Replaced by #96424 |
No description provided.