Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc improvements #26

Merged
merged 3 commits into from
Sep 30, 2024
Merged

Doc improvements #26

merged 3 commits into from
Sep 30, 2024

Conversation

kolyshkin
Copy link
Contributor

No description provided.

@kolyshkin
Copy link
Contributor Author

a panic in a test in unrelated but interesting

=== RUN   TestPartialLookup_RacingRename/openat2=true/swap-dir-danglinglink-basic
panic: renameat2([-1]"/tmp/TestPartialLookup_RacingRenameopenat2=trueswap-dir-file-basic3291115487/001/tree", "a/b", ..., "file", RENAME_EXCHANGE) = no such file or directory

goroutine 552 [running]:
github.com/cyphar/filepath-securejoin.doRenameExchangeLoop(0xc000027680, 0xc0000276e0, 0xc0000025a8, {0x66c786, 0x3}, {0x66c8f4, 0x4})
	/home/runner/work/filepath-securejoin/filepath-securejoin/util_linux_test.go:111 +0x38c
created by github.com/cyphar/filepath-securejoin.TestPartialLookup_RacingRename.func1.1 in goroutine 551
	/home/runner/work/filepath-securejoin/filepath-securejoin/lookup_linux_test.go:561 +0x525
exit status 2

@cyphar
Copy link
Owner

cyphar commented Sep 30, 2024

Yeah it's started failing recently. Hmmm...

@cyphar
Copy link
Owner

cyphar commented Sep 30, 2024 •
edited
Loading

#30 should fix the issue. Let me rebase this...

@kolyshkin @cyphar
Remove osVFS methods documentation
daead99 
These methods are not public, and their docstrings are copies of
those from the VFS interface methods.

Signed-off-by: Kir Kolyshkin <[email protected]>
@kolyshkin @cyphar
Add cross-links to godoc
5b5a7a4 
Since Go 1.19 it is possible to link to other identifiers. Let's use it.

Signed-off-by: Kir Kolyshkin <[email protected]>
@kolyshkin @cyphar
OpenInRoot: add CVE link to godoc
09afcf2 
Signed-off-by: Kir Kolyshkin <[email protected]>
@cyphar cyphar merged commit 2b3d97d into cyphar:main Sep 30, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kolyshkin @cyphar