Skip to content

compression: Add some doc comments#1939

Merged
openshift-merge-bot[bot] merged 1 commit intocontainers:mainfrom
cgwalters:misc-doc-comments
Jun 3, 2024
Merged

compression: Add some doc comments#1939
openshift-merge-bot[bot] merged 1 commit intocontainers:mainfrom
cgwalters:misc-doc-comments

Conversation

@cgwalters
Copy link
Copy Markdown
Contributor

I'm digging in more to zstd:chunked and I hope these comments are useful.

@cgwalters cgwalters marked this pull request as ready for review June 3, 2024 18:36
@rhatdan
Copy link
Copy Markdown
Member

rhatdan commented Jun 3, 2024

LGTM
@giuseppe PTAL
Lint is not happy.

I'm digging in more to zstd:chunked and I hope these comments are
useful.

Signed-off-by: Colin Walters <walters@verbum.org>
@cgwalters cgwalters force-pushed the misc-doc-comments branch from af21344 to d78daad Compare June 3, 2024 18:54
Copy link
Copy Markdown
Member

@giuseppe giuseppe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Jun 3, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cgwalters, giuseppe

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved label Jun 3, 2024
@rhatdan
Copy link
Copy Markdown
Member

rhatdan commented Jun 3, 2024

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Jun 3, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit 9661c8f into containers:main Jun 3, 2024
// <offset>:<length>:<uncompressed length>
TarSplitInfoKey = "io.github.containers.zstd-chunked.tarsplit-position"

// TarSplitChecksumKey is deprecated: Use the TOC.TarSplitDigest field instead, this annotation is no longer read nor written.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW the exact // Deprecated: text is treated as special by Go tooling and linters.

(I know, that’s horrible.)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cgwalters added a commit to cgwalters/storage that referenced this pull request Jun 7, 2024
- Address containers#1939 (review)
- Also just go ahead and comment this out because it's not used,
  but I think it makes sense to retain as a historical reference

Signed-off-by: Colin Walters <walters@verbum.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants