Repository navigation
Conversation
Fix statements in the SwiftPM and ios-prebuild __docs__ that no longer match the code: CLI options, exit code 2 causes, what sync does and when it re-runs, which command writes each file, header products, remote mode, and header sidecar layout. Add an environment variables table.
meta-cla
Bot
added
the
CLA Signed
facebook-github-tools
Bot
added
the
Shared with Meta
Remove repeated statements, split long sentences, and move the header resolution details into spm-header-paths-contract.md. No facts change.
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary:
Several statements in the SwiftPM docs no longer match the scripts on
main. This PR corrects them. It changes docs only.scripts/spm/__docs__: CLI options, the three causes of exit code 2, whatsyncdoes and when it re-runs, which command writes each file, the header products a hand-written library depends on, and remote mode. Adds a table of environment variables.scripts/ios-prebuild/__docs__: the SwiftPM statements about where dependency and Hermes headers go.Where the code has a known gap, the docs describe the current behavior. Examples:
npx react-native spmdoes not forward--configCommand, andspm scaffoldalso changes the.xcodeproj.A second commit simplifies the same docs: it removes repeated statements and splits long sentences. No facts change. The header resolution details move to
spm-header-paths-contract.md.Changelog:
[INTERNAL] [CHANGED] - Correct SwiftPM docs to match current scripts
Test Plan:
npx prettier --check packages/react-native/scripts/{spm,ios-prebuild}/__docs__/*.md: all files pass.main. Relative links and anchors in changed lines resolve.