doc: update docs in ociTools, follow doc conventions #290886
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
infinisil
requested changes
Feb 29, 2024
infinisil
force-pushed
the
update-ocitools
branch
from
cc22b6a
to
c73de6f
Compare
infinisil
approved these changes
Feb 29, 2024
ofborg
bot
added
10.rebuild-linux: 1-10
10.rebuild-linux: 1
and removed
10.rebuild-linux: 0
labels
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2024-02-29-documentation-team-meeting-notes-111/40525/1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
This PR clarifies a lot of things that were confusing, unsaid, or unclear in the previous documentation, adds more content to properly document the function in
ociTools, and follows the docs conventions.A few of the attributes I documented are not needed (see #290881), but I decided to document them with a "deprecated" tag. On a follow-up PR, I'll remove those attributes from the code and from the docs. I chose to do this in separate PRs so I can properly organise work that is purely related to updating docs content and work that is related to code maintenance/bug fixing.
Things done
nix.conf? (See Nix manual)sandbox = relaxedsandbox = truenix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage./result/bin/)Add a 馃憤 reaction to pull requests you find important.