You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Problem: running uncrustify is a required step when developers submit PRs. However, running the wrong version of uncrustify will result in undesirable code changes. On Ubuntu at least, the latest version of uncrustify currently available for a simple installation (v 0.59) is too old, and gives bad results. Upgrading to 0.64 or later fixes the problem (we don't know the exact version that fixes the problem; all we know is that 0.64 is new enough). This required extra effort on my part to explicitly download the source code for a newer version of uncrustify and build it.
Proposed solution: we should add a clear statement to the online documentation that uncrustify 0.64 or later is required, if one wants to submit a PR (and fulfill the uncrustify requirement of the PR). It's only necessary for developers, so I guess the statement should go somewhere in the development section.
Note also that running uncrustify within the vic_test_env environment MIGHT also be necessary. Haven't tested that for sure. I'll try to find out and update this.
The text was updated successfully, but these errors were encountered:
jhamman
changed the title
[Bug] Documentation needs to list uncrustify (with version) as a required dependency
Documentation needs to list uncrustify (with version) as a required dependency
Feb 23, 2018
@tbohn - uncrustify is not exactly a "required dependency". While it is for developers, it is not for most users so I'm hesitant to elevate its place in the dependency list. That said, I think we should add a few notes about the traditional development environment to this page: http://vic.readthedocs.io/en/master/Development/Contributing/
I can take care of this when I get back (I'm out tomorrow and this weekend)
tbohn
changed the title
Documentation needs to list uncrustify (with version) as a required dependency
Documentation needs to list the version of uncrustify that is required for development
Feb 23, 2018
The text was updated successfully, but these errors were encountered: