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

update to specify the proper active directory to docs #5260

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

netskink
Copy link

@netskink netskink commented Oct 3, 2023

This in reference to this issue

@SimplyDanny
Copy link
Collaborator

SimplyDanny commented Oct 16, 2023

I think these steps are already covered by this section, aren't they?

@netskink
Copy link
Author

No that is why I'm adding it to that section. Please search on Xcode select in that section and show me where it's mentioned.

@SimplyDanny
Copy link
Collaborator

xcode-select isn't something specific for SwiftLint. It's the common way to switch between Xcode toolchains. Thus, we don't need to explain.

The section I mentioned definitely relates to it. The point is that Xcode must be installed; nothing more. SwiftLint looks for SourceKit at the locations listed there. xcode-select isn't needed at all. You may just set $XCODE_DEFAULT_TOOLCHAIN_OVERRIDE, $TOOLCHAIN_DIR or $TOOLCHAINS to make SwiftLint find special Xcodes at exotic locations.

That said, what might be left for the README is the fact that a full Xcode must be installed (preferably) at a default location. But this applies to all installation methods and should at most be mentioned there.

@netskink
Copy link
Author

Very good. Is these environment variables specified in the docs? If not would it be wise to specify?

@SimplyDanny
Copy link
Collaborator

Very good. Is these environment variables specified in the docs? If not would it be wise to specify?

Yes, they are here.

@netskink
Copy link
Author

In the section titled "working with multiple swift versions"?

@SimplyDanny
Copy link
Collaborator

In the section titled "working with multiple swift versions"?

Yes.

@netskink
Copy link
Author

So I only have one swift version installed. That section is a long way off from the initial installation instructions. Not to mention the section you referenced is not explicit to provide the correct procedure.

With that said do you still feel the documentation does not need to be modified?

After all this is a tool to make higher quality code and one aspect is that code be simplified and easier to understand, right?

@SimplyDanny
Copy link
Collaborator

After all this is a tool to make higher quality code and one aspect is that code be simplified and easier to understand, right?

Yes, and one aspect of high quality is to avoid redundancy. I just want to make sure the README contains the relevant points but not more.

If you think the section is too far away from the "Installation" section, link to it from there or move it. Fine with me, if you mention xcode-select as a tool to change default Xcode installations. I really wouldn't do more here though.

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