Run codespell on code #1714
Run codespell on code #1714
Conversation
types/options.go
Outdated
| // Image Store is the location of image store which is seperated from the | ||
| // Image Store is the location of image store which is separated from the | ||
| // container store. Usually this is not recommended unless users wants | ||
| // seperate store for image and containers. | ||
| // separate store for image and containers. |
There was a problem hiding this comment.
I think this needs more than just spelling fixes? The first correction should IMO also be "separate", not separated. And the second instance is just repetition, not really helpful. Is there a way to phrase that such that it would explain the why, not the what?
There was a problem hiding this comment.
Ok I took a stab at improving the description of imagestore in all locations.
rhatdan
force-pushed
the
codespell
branch
4 times, most recently
from
be9cb23
to
d53c1fd
Compare
docs/containers-storage.conf.5.md
Outdated
|
|
||
| A common use case for this field is for the users who want to split the file-system in different parts i.e disk which stores images vs disk used by the container created by the image. | ||
| Common use cases for this field is users who need to split file-systems in different partitions. A partition to store images vs a partition for storing container content created from the image. |
There was a problem hiding this comment.
Mismatched plural/singular; I think it reads better as it was, "A common use case" (not "common use cases")
"filesystem" is one word
Standard usage requires commas before and after i.e. and e.g.. I'm not a 100% stickler about that, but one comma at least should be added. And this is an e.g. (exampla gratia(sp?)), not i.e. (id est, that is). So: "..different locations, e.g. one partition to store images and one to store containers"?
docs/containers-storage.conf.5.md
Outdated
| @@ -56,10 +56,9 @@ $ restorecon -R -v /NEWSTORAGEPATH | |||
| A common use case for this field is to provide a local storage directory when user home directories are NFS-mounted (podman does not support container storage over NFS). | |||
|
|
|||
| **imagestore**="" | |||
| image storage path (the default is assumed to be the same as `graphroot`). | |||
| Path of imagestore different from `graphroot`, by default storage library stores all images in `graphroot` but if `imagestore` is provided it will store newly pulled images in provided `imagestore` but will keep using `graphroot` for everything else. If user is using `overlay` driver then images which were already part of `graphroot` will still be accessible ( Internally storage library will mount `graphroot` as an `additionalImageStore` to allow this behaviour ). | |||
| image storage path (the default is assumed to be the same as `graphroot`). Path of imagestore different from `graphroot`. By default images in the storage library are stored int the `graphroot`. If `imagestore` is provided newly pulled images will be stored in the `imagestore` location. All other storage continues to be stored in the `graphroot`. When using `overlay` driver images previously stored in the `graphroot` continue to be accessible ( Internally storage library mounts `graphroot` as an `additionalImageStore` to allow this behaviour ). | |||
There was a problem hiding this comment.
Suggestion: add comma: "if imagestore is provided, newly ..."
docs/containers-storage.conf.5.md
Outdated
| @@ -56,10 +56,9 @@ $ restorecon -R -v /NEWSTORAGEPATH | |||
| A common use case for this field is to provide a local storage directory when user home directories are NFS-mounted (podman does not support container storage over NFS). | |||
|
|
|||
| **imagestore**="" | |||
| image storage path (the default is assumed to be the same as `graphroot`). | |||
| Path of imagestore different from `graphroot`, by default storage library stores all images in `graphroot` but if `imagestore` is provided it will store newly pulled images in provided `imagestore` but will keep using `graphroot` for everything else. If user is using `overlay` driver then images which were already part of `graphroot` will still be accessible ( Internally storage library will mount `graphroot` as an `additionalImageStore` to allow this behaviour ). | |||
| image storage path (the default is assumed to be the same as `graphroot`). Path of imagestore different from `graphroot`. By default images in the storage library are stored in the `graphroot`. If `imagestore` is provided, newly pulled images will be stored in the `imagestore` location. All other storage continues to be stored in the `graphroot`. When using `overlay` driver images previously stored in the `graphroot` continue to be accessible ( Internally storage library mounts `graphroot` as an `additionalImageStore` to allow this behaviour ). | |||
There was a problem hiding this comment.
I still find this hard to grok. It's missing a couple of commas, and is a little confusing, but it's better than it was, so thank you.
Cleanup description of imagestore. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: flouthoc, rhatdan The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
No description provided.