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 CMake README #23

Merged
merged 2 commits into from
Aug 21, 2018
Merged

Update CMake README #23

merged 2 commits into from
Aug 21, 2018

Conversation

PaulWessel
Copy link
Member

The readme file for cmake discusses subversion. I made the changes I think are needed for git.

The only question has to do with the GMT_SOURCE_CODE_CONTROL_VERSION_STRING since svn uses integers and git the hash?

THe readme file for cmake discusses subversion.  I made the changes I think are needed for git.
@PaulWessel PaulWessel requested a review from a team August 17, 2018 23:56
@leouieda
Copy link
Member

I would suggestion using a git tag to mark the release commit. It's human readable at least and can be used to git checkout same way as a hash.

That said, using the hash also works fine.

Copy link
Contributor

@remkos remkos left a comment

Choose a reason for hiding this comment

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

I actually agree with the changes, from my experience moving from SVN to Git this is sufficient.

@@ -179,7 +179,7 @@ Set GMT_RELEASE_PREFIX in cmake/ConfigUser.cmake and run cmake. Then do
You should then edit ${GMT_RELEASE_PREFIX}/cmake/ConfigDefault.cmake and
set GMT_PACKAGE_VERSION_MAJOR, GMT_PACKAGE_VERSION_MINOR, and
GMT_PACKAGE_VERSION_PATCH. Also uncomment and set
GMT_SOURCE_CODE_CONTROL_VERSION_STRING to the current svn version. Then
GMT_SOURCE_CODE_CONTROL_VERSION_STRING to the current git version. Then
Copy link
Member

Choose a reason for hiding this comment

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

But what would contain the GMT_SOURCE_CODE_CONTROL_VERSION_STRING? With SVN it was the revision number but in git we have only hash numbers.

Copy link
Member Author

Choose a reason for hiding this comment

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

That is OK I think. A release will say 6.0.0 but until then it says
pwessel@MacBeth:~-> gmt --version
6.0.0_r49baf49

Copy link
Member

Choose a reason for hiding this comment

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

Right, but when it's defined (gmt_version.h.in) it falls to @GMT_PACKAGE_VERSION_WITH_SVN_REVISION@

#ifdef GMT_SOURCE_CODE_CONTROL_VERSION_STRING
#	define GMT_STRING "@GMT_PACKAGE_VERSION_WITH_SVN_REVISION@ (r@GMT_SOURCE_CODE_CONTROL_VERSION_STRING@)"

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we need to make some edits there as well.

@leouieda
Copy link
Member

It would be good to drop the leading r in the version string. The git hash has letters and numbers so that r might be mistaken for part of the hash.

makes no sense to have a prepended r to the git hash string
Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

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

Looks good to me

@PaulWessel PaulWessel merged commit 6136b6a into master Aug 21, 2018
@PaulWessel PaulWessel deleted the readmefix branch August 21, 2018 03:53
@seisman
Copy link
Member

seisman commented Aug 22, 2018

I tried to compile the master branch. It still gives a version string with a letter 'r'.

$ gmt --version
6.0.0_r63665d7

63665d7 is the hash of the latest commit.

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.

None yet

5 participants