Skip to content

Add help intro #772

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.

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

Merged
merged 1 commit into from
Sep 20, 2021
Merged

Add help intro #772

merged 1 commit into from
Sep 20, 2021

Conversation

bitjammer
Copy link
Contributor

@bitjammer bitjammer commented Jul 23, 2021

Note: This PR is for a pitch discussion and building a test toolchain. Please don't merge this – thanks!

Add an "intro" topic to swift-help, printing the version, welcome message, and
available subcommands.

When running swift by itself, show the intro before entering the REPL.

When running swift-help directly or via swift --help, show all of the
available flags as previously.

rdar://78280423

More context: https://forums.swift.org/t/command-line-ux-enhancements-for-swift/50670

@bitjammer
Copy link
Contributor Author

Please test with following pull request:
swiftlang/llvm-project#3125

@swift-ci Please Build Toolchain macOS Platform

@bitjammer
Copy link
Contributor Author

Please test with the following pull request:
swiftlang/llvm-project#3125

@swift-ci Please Build Toolchain Linux Platform

@artemcm
Copy link
Contributor

artemcm commented Jul 23, 2021

Please test with following pull request:
apple/llvm-project#3125

@swift-ci Please Build Toolchain macOS Platform

@bitjammer , I believe that currently @swift-ci Please Build Toolchain only works from PRs on the main Swift repo.

@bitjammer
Copy link
Contributor Author

I see. @shahmishal @artemcm is it possible to kick off a build manually with the infrastructure referencing these two PRs?

@artemcm
Copy link
Contributor

artemcm commented Jul 23, 2021

I see. @shahmishal @artemcm is it possible to kick off a build manually with the infrastructure referencing these two PRs?

You can create an empty PR in the Swift repo and launch a toolchain build referencing both:
#772
swiftlang/llvm-project#3125

@artemcm artemcm closed this Jul 23, 2021
@artemcm artemcm reopened this Jul 23, 2021
@bitjammer
Copy link
Contributor Author

Okay I think I will probably hold off on that for the moment, since that could be confusing to the folks that might want it.

@bitjammer
Copy link
Contributor Author

Thank you!

@bitjammer bitjammer force-pushed the acgarland/help-intro branch 6 times, most recently from c1c969e to 602a222 Compare August 10, 2021 02:11
@bitjammer bitjammer force-pushed the acgarland/help-intro branch 3 times, most recently from b08905f to 54f5dac Compare August 12, 2021 07:07
@bitjammer bitjammer changed the title [Do not merge] Add help intro Add help intro Aug 18, 2021
@bitjammer bitjammer requested a review from artemcm August 18, 2021 21:10
@bitjammer
Copy link
Contributor Author

@artemcm Do you know who could review the LLDB change for this? swiftlang/llvm-project#3125

@bitjammer
Copy link
Contributor Author

@swift-ci Please test

@bitjammer
Copy link
Contributor Author

@artemcm Aside from the conflict, does this look okay to you?

@bitjammer bitjammer force-pushed the acgarland/help-intro branch from 54f5dac to 0256190 Compare September 9, 2021 21:44
@bitjammer
Copy link
Contributor Author

@swift-ci Please test

Copy link
Contributor

@artemcm artemcm left a comment

Choose a reason for hiding this comment

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

These changes look good to me, and I particularly like the REPL intro. Thanks, @bitjammer.

@@ -32,6 +32,9 @@

/// Dump information about a precompiled Clang module
case dumpPCM

/// Introduce the user to Swift concepts depending on context.
case intro
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems that this PR does not actually make use of this. I am guessing the intent is to have this become the interactive/contextual driver invocation kind in the future when swift no longer launches the REPL?

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps this calls us to rename this enum into DriverMode, if we're introducing modes of operation to it that may have little to do with the compiler.

@bitjammer
Copy link
Contributor Author

@swift-ci Please test

Add an "intro" topic to swift-help, printing the version, welcome message, and
available subcommands.

When running `swift` by itself, show the intro before entering the REPL.

When running `swift-help` directly or via `swift --help`, show all of the
available flags as previously.

rdar://78280423
@bitjammer
Copy link
Contributor Author

Looks like an unrelated assertion failure, will try again in a little while.

@bitjammer
Copy link
Contributor Author

@swift-ci Please test

@artemcm
Copy link
Contributor

artemcm commented Sep 20, 2021

@swift-ci please test

@bitjammer bitjammer merged commit c5f11e5 into swiftlang:main Sep 20, 2021
@bitjammer bitjammer deleted the acgarland/help-intro branch September 20, 2021 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants