From a7779a1029dec5fd60f86479a8e41ce57d2c12b7 Mon Sep 17 00:00:00 2001 From: Damien Tardy-Panis Date: Fri, 7 Oct 2016 18:06:04 +0200 Subject: [PATCH] stamp: add warning in documentation about corner case --- man/git-stamp.1 | 3 +++ man/git-stamp.html | 4 +++- man/git-stamp.md | 2 ++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/man/git-stamp.1 b/man/git-stamp.1 index 207ed90..3c4d8b2 100644 --- a/man/git-stamp.1 +++ b/man/git-stamp.1 @@ -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 . diff --git a/man/git-stamp.html b/man/git-stamp.html index 776ee3d..f443963 100644 --- a/man/git-stamp.html +++ b/man/git-stamp.html @@ -87,6 +87,8 @@ By default all stamps are appended as a new paragraph to the commit message.
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

@@ -141,7 +143,7 @@ $ git stamp Issue FOO-456 \#close

AUTHOR

-

Written by Damien Tardy-Panis <damien@tardypad.me>

+

Written by Damien Tardy-Panis <damien@tardypad.me>

REPORTING BUGS

diff --git a/man/git-stamp.md b/man/git-stamp.md index d7d8975..da97c68 100644 --- a/man/git-stamp.md +++ b/man/git-stamp.md @@ -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