Skip to content

Commit 467555b

Browse files
committed
Some clarifications on the docs
1 parent 461eae6 commit 467555b

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,17 @@ add these repos to your `settings.xml` or your project `pom.xml`. Example:
7272
<tr>
7373
<td>tstampFormat</td>
7474
<td>yyyyMMddHHmmss</td>
75-
<td>Specify a custom format for the `build-tstamp` property. Use the pattern syntax defined by Java's [SimpleDateFormat](http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html)</td>
75+
<td>Specify a custom format for the `build-tstamp` property. Use the pattern syntax defined by Java's <a href="http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat</a></td>
7676
</tr>
7777
<tr>
7878
<td>customProperties</td>
7979
<td>-</td>
80-
<td>Optional. A Clojure snippet of code that evaluates to a Map. You have locally define symbols for each `build-*` property. The Map returned is merged into the project properties. See below for examples.</td>
80+
<td>Optional. A Clojure snippet of code you may specify in order to modify or create new properties. The code must evaluate to a Map. The name of the keys in the Map become Maven properties on the project. For convenience, for each `build-*` property you have a local variable with the same name already defined for you. See below for an example.</td>
8181
</tr>
8282
</table>
8383

8484

85-
Example 1:
85+
Example:
8686

8787
```xml
8888
<plugin>
@@ -128,15 +128,15 @@ Reference:
128128

129129
* [Another explanation](http://www.xerxesb.com/2010/git-describe-and-the-tale-of-the-wrong-commits/) of this same issue with `git describe`.
130130
* [GIT mailing list discussion](http://kerneltrap.org/mailarchive/git/2010/9/21/40071/thread) about `git describe`'s logic and lack of `--first-parent`.
131-
* Here's a [working patch to add `--first-parent` to `git describe`](https://github.com/gitigit/git/tree/mrb/describe-first-parent)
131+
* Here's a [working patch to add `--first-parent` to `git describe`](https://github.com/git/git/tree/mrb/describe-first-parent)
132132

133133
## Future
134134

135135
Some ideas:
136136

137137
* Find a way to inject the project version from git tags into the project's
138-
pom. The goal is to get rid of the need to modify the project version inside
139-
`pom.xml`: just leave a fixed 0.0.0 version and let the plugin infer it from
138+
pom. The goal is to stop maintaining the project version inside
139+
`pom.xml`: just leave the pom version fixed at 0.0.0 and let the plugin infer it from
140140
git. We tried the obvious: calling project.setVersion(), but some Maven phases
141141
still "see" the version that is in the `pom.xml` file. Need to research
142142
further.
@@ -166,4 +166,5 @@ addition. He did the heavy-lifting to integrate Clojure with Maven and Plexus.
166166

167167
## License
168168
Licensed under the [Eclipse Public License](http://www.eclipse.org/legal/epl-v10.html).
169-
Copyright 2012 Code54 S.A. (http://code54.com)
169+
Copyright 2012 Fernando Dobladez & Code54 S.A. (http://code54.com)
170+

0 commit comments

Comments
 (0)