Readme out of date

[louisburton]

Didn't seem to match up as I saw it.
I had to specify values in the gitDescribeConfig as the defaults didn't come through. I am using maven 3.1.1.
One property is reported as 'long' but actually is 'forceLongFormat'.

[ktoso]

Thanks for reporting! Pull request would be awesome if you'd like to give it a shot!

[ktoso]

Which property exactly, and which version of the plugin?

[louisburton]

Sorry, version 2.1.9 of the plugin.
I found I had to add the gitDescribe tag with all values, otherwise the documented defaults didn't come up (i.e. no dirty string such as '-dirty', and the default abbrev was 0 leading to no git ref also - I had to set this to 7 to be picked up).

                        <gitDescribe>
                            <abbrev>7</abbrev>
                            <dirty>-DEV</dirty>
                            <tags>true</tags>
                            <forceLongFormat>true</forceLongFormat>
                            <always>true</always>
                        </gitDescribe>

It was as if the Java defaults were used instead, maybe this is because I'm using maven 3 and the mojo doesn't use org.apache.maven.plugins.annotations.Parameter? Although I'd find it surprising that the old style is not still supported...
Also, some values did get a non Java default, such as failOnNoGitDirectory being true until I set it to false explicitly.

<!-- true is default here, it prints some more information during the build -->
                    <verbose>true</verbose>

The above default isn't true either, I had to set it true explicitly to get debug.

NB. Thanks for the work, and quickest response ever.

[louisburton]

I now see this may be also related to #86

[ktoso]

I've updated the verbose setting. The gitDescribe problem is rather a bug than a readme problem... We'll look into it -- pull requests are very welcome!

[ktoso]

I went over options and most have been fixed or missed in or location.
Should be good for 2.1.12, if not please tell me which ones.