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.

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

[SR-1421] 'sourcekitd-test -help' should print help, list available request types #44030

Closed
modocache mannequin opened this issue May 5, 2016 · 5 comments
Closed

[SR-1421] 'sourcekitd-test -help' should print help, list available request types #44030

modocache mannequin opened this issue May 5, 2016 · 5 comments
Labels
good first issue Good for newcomers improvement

Comments

@modocache
Copy link
Mannequin

modocache mannequin commented May 5, 2016

Previous ID SR-1421
Radar None
Original Reporter @modocache
Type Improvement
Status Resolved
Resolution Done
Additional Detail from JIRA
Votes 0
Component/s Source Tooling
Labels Improvement, StarterBug
Assignee felix91gr (JIRA)
Priority Medium

md5: fc126e032a3e4bade6269e4d58045eb8

Issue Description:

Invoking sourcekitd-test with no arguments emits the following:

$ sourcekitd-test
request is not set
USAGE:  [options]

OPTIONS:
  -help    - Display available options (-help-hidden for more)
  -version - Display the version of this program

However, sourcekitd-test does not actually respond to the -help option:

$ sourcekitd-test -help
error: unknown argument: -help

Instead, -help should print out a basic description of the tool, as well as some of the available commands (at least the ones documented in https://github.com/apple/swift/blob/5302e3859ce52322e4a0051e1101399e4f37d25d/tools/SourceKit/docs/Protocol.md).
@modocache
Copy link
Mannequin Author

modocache mannequin commented May 7, 2016

Whatever help text is added should reference the SOURCEKIT_LOGGING environment variable. You can set it to a value between 1 and 3 in order to have SourceKit emit a bunch of useful debugging information:

$ SOURCEKIT_LOGGING=3 sourcekitd-test -req=doc-info helloSourceKit.swift -- helloSourceKit.swift

@keith
Copy link
Collaborator

keith commented Aug 19, 2016

With the latest sourcekitd-test I no longer get this help message:

% ./sourcekitd-test
request is not set

@swift-ci
Copy link
Collaborator

swift-ci commented Apr 6, 2017

Comment by Félix Fischer (JIRA)

I want to take this SR. I work on Linux, and thanks to Norio Nomura I've managed to compile sourcekit and run sourcekitd-test.

Sourcekit still fails many tests on Linux, but sourcekitd-test runs. Therefore, the --help argument should give no problems.

I'll take the SR and... we'll see how it goes :3

@swift-ci
Copy link
Collaborator

Comment by Félix Fischer (JIRA)

Fixed it 😃 PR_8746

@swift-ci
Copy link
Collaborator

Comment by Félix Fischer (JIRA)

Solved in #8746

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@keith @swift-ci