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

Document required git version #1181

Merged
merged 1 commit into from
Jul 28, 2016
Merged

Document required git version #1181

merged 1 commit into from
Jul 28, 2016

Conversation

lencioni
Copy link
Contributor

git-describe was taught --abbrev=0 in 1.5.0:

https://github.com/git/git/blob/master/Documentation/RelNotes/1.5.0.txt

git-describe was taught --match in 1.5.5:

https://github.com/git/git/blob/master/Documentation/RelNotes/1.5.5.txt

I don't see anything else potentially weird in here, so I think it is
safe to proclaim that the minimum git version required to run these
commands is 1.5.5.

Documenting this minimum version required here should help people debug
possible issues and help maintainers of this project understand the
impacts of modifying these commands in the future.

git-describe was taught `--abbrev=0` in 1.5.0:

  https://github.com/git/git/blob/master/Documentation/RelNotes/1.5.0.txt

git-describe was taught `--match` in 1.5.5:

  https://github.com/git/git/blob/master/Documentation/RelNotes/1.5.5.txt

I don't see anything else potentially weird in here, so I think it is
safe to proclaim that the minimum git version required to run these
commands is 1.5.5.

Documenting this minimum version required here should help people debug
possible issues and help maintainers of this project understand the
impacts of modifying these commands in the future.
@ljharb
Copy link
Member

ljharb commented Jul 28, 2016

Perhaps here we could do a check for the git version, and log something to stderr about it, before proceeding to the curl/wget checks?

@lencioni
Copy link
Contributor Author

I'm not entirely sure I follow.

Also, that seems to already include a git version check of sorts: https://github.com/creationix/nvm/blob/c874a174791265b3ab614ea270a84335a1013be0/install.sh#L91

@ljharb
Copy link
Member

ljharb commented Jul 28, 2016

I think that check is just checking for "show-ref" support - when was that added?

@lencioni
Copy link
Contributor Author

It looks like git-show-ref was added by 358ddb62cf in 2006, which appears to be first included by 1.4.4. The release notes don't go back that far though.

git/git@358ddb62cf

@ljharb
Copy link
Member

ljharb commented Jul 28, 2016

I think an explicit version check would be nice - if you don't want to add it here, that's OK, this is still an improvement :-)

@lencioni
Copy link
Contributor Author

I think I'll leave it out.

@ljharb ljharb added informational installing nvm Problems installing nvm itself labels Jul 28, 2016
@ljharb ljharb merged commit f51b1bf into nvm-sh:master Jul 28, 2016
@ljharb ljharb self-assigned this Jul 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
informational installing nvm Problems installing nvm itself
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants