Work around https://github.com/swiftlang/swift-foundation/issues/1125 #1169
Conversation
This file contains hidden or 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
rdar://146539299
d-ronnqvist
commented
Mar 13, 2025
| @@ -39,7 +39,7 @@ package protocol FileManagerProtocol: DataProvider { | |||
| /// Returns `true` if a file exists at the given path. | |||
| func fileExists(atPath: String) -> Bool | |||
| /// Copies a file from one location on the file-system to another. | |||
| func copyItem(at: URL, to: URL) throws | |||
| func _copyItem(at: URL, to: URL) throws // Use a different name than FileManager to work around https://github.com/swiftlang/swift-foundation/issues/1125 | |||
There was a problem hiding this comment.
I don't know if there's a better name for this but I'd be happy to rename it if anyone has a better suggestion.
AFAIK it needs to be a different name than copyItem(at:to:) so that we can provide a custom implementation for FileManager that calls the real NSFileManager/copyItem(at:to:) without causing an infinite recursion.
There was a problem hiding this comment.
For example, we could spell it out like func copyItemWithWorkaround(at: URL, to: URL) or something like that.
|
@swift-ci please test |
2 tasks
xtremekforever
pushed a commit
to xtremekforever/swift-docc
that referenced
this pull request
Apr 10, 2025
rdar://146539299
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.
Bug/issue #, if applicable: rdar://146539299 #1136
Summary
This works around swiftlang/swift-foundation#1125 for all the copy item operations that DocC does to avoid potential permission issues when copying file attributes over to the otherwise successfully copied items.
Dependencies
None.
Testing
Rephrased from #1136:
/or/usr/libexec/swift.docc convertfrom the system directory.The
convertaction should succeed, without permission error or other unexpected file write errors.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
[ ] Added tests./bin/testscript and it succeeded[ ] Updated documentation if necessaryAdded in-source comments to explain the workaround.