Skip to content

incorrect docs on tars attribute in oci_image #853

@jalkjaer

Description

@jalkjaer

The explaination of why the tars list should not be sorted in https://github.com/bazel-contrib/rules_oci/blob/main/docs/image.md?plain=1#L82
is not correct, (Dockerfile cargo-culting?)

List of tar files to add to the image as layers. Do not sort this list; the order is preserved in the resulting image. Less-frequently changed files belong in lower layers to reduce the network bandwidth required to pull and push.

The order only affects file shadowing, when running the image as a container. (well and the tiny manifest which holds the list of layers)

Tried to rephrase in a PR, but it gets complicated and my tech writing skill are not that good.
Also 'lower' is problematic - the lowest layer would be the first layer in the overlay fs - but that is un-intutive when looking a list of tars separated with newlines

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions