stamp: add warning in documentation about corner case

This commit is contained in:
Damien Tardy-Panis 2016-10-07 18:06:04 +02:00
parent 9ea8f98e5c
commit a7779a1029
3 changed files with 8 additions and 1 deletions

View file

@ -24,6 +24,9 @@ You can change this behavior by using the \-\-replace flag\.
.br
With this flag, all the related stamps with the same identifier will be removed first before the new one gets appended\.
.
.P
\fBWARNING!\fR If a commit message without stamp have a line starting with the same identifier, it will be interpreted as a stamp
.
.SH "OPTIONS"
\-r, \-\-replace
.

View file

@ -87,6 +87,8 @@ By default all stamps are appended as a new paragraph to the commit message.<br
You can change this behavior by using the --replace flag.<br />
With this flag, all the related stamps with the same identifier will be removed first before the new one gets appended.</p>
<p><code>WARNING!</code> If a commit message without stamp have a line starting with the same identifier, it will be interpreted as a stamp</p>
<h2 id="OPTIONS">OPTIONS</h2>
<p> -r, --replace</p>
@ -141,7 +143,7 @@ $ git stamp Issue FOO-456 \#close
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Damien Tardy-Panis &lt;<a href="&#109;&#x61;&#105;&#x6c;&#116;&#x6f;&#58;&#100;&#x61;&#x6d;&#x69;&#101;&#x6e;&#64;&#116;&#x61;&#114;&#100;&#121;&#x70;&#x61;&#x64;&#x2e;&#x6d;&#x65;" data-bare-link="true">&#x64;&#x61;&#x6d;&#x69;&#101;&#110;&#x40;&#116;&#97;&#x72;&#100;&#x79;&#x70;&#97;&#x64;&#x2e;&#x6d;&#x65;</a>&gt;</p>
<p>Written by Damien Tardy-Panis &lt;<a href="&#x6d;&#97;&#x69;&#x6c;&#116;&#111;&#58;&#x64;&#97;&#x6d;&#105;&#x65;&#x6e;&#64;&#x74;&#97;&#x72;&#100;&#x79;&#112;&#97;&#x64;&#46;&#x6d;&#x65;" data-bare-link="true">&#100;&#x61;&#109;&#x69;&#101;&#x6e;&#64;&#x74;&#97;&#x72;&#x64;&#121;&#112;&#97;&#x64;&#x2e;&#x6d;&#101;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

View file

@ -14,6 +14,8 @@ By default all stamps are appended as a new paragraph to the commit message.
You can change this behavior by using the --replace flag.
With this flag, all the related stamps with the same identifier will be removed first before the new one gets appended.
`WARNING!` If a commit message without stamp have a line starting with the same identifier, it will be interpreted as a stamp
## OPTIONS
-r, --replace