Add documentation about SSH_AUTH_SOCK from PR#1184 #1185
Merged
Conversation
This file contains 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
PR#1184 added support for propagating SSH_AUTH_SOCK if it points to a valid unix socket. As requested, add a section explaining how to use it.
Replace references to `$(pwd)` with `$PWD` in shell snippets and add more quoting. This should make these snippets reasonably friendly to currnet working directory path components containing spaces. Note: I neither endorse nor recommend spaces in directories, but this is an easy enough change. This commit is leaving powershell snippets untouched as I am not familiar with powershell's word-splitting behavior (if there is any).
🚀
manugupt1
approved these changes
Apr 30, 2019
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.
#1184 added support for propagating
SSH_AUTH_SOCKif it points to avalid unix socket. As requested by @arschles, add a section explaining how to use
it.
While I'm touching the documentation, also protect references to the current working directory by converting
$(pwd)to quoted references to the$PWDpseudo-environment variable, which avoids issues with word-splitting in bash and most othersh-compatible shells.