[StGIT PATCH] Document shortcoming of stg-k and stg-unnew.
Signed-off-by: Yann Dirson <ydirson@altern.org>
---
contrib/stg-k | 8 +++++---
contrib/stg-unnew | 3 +++
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/contrib/stg-k b/contrib/stg-k
index 0134c25..62211be 100755
--- a/contrib/stg-k
+++ b/contrib/stg-k
@@ -8,11 +8,13 @@ set -e
# essence, "stg-k pop" is a "stg pop -k" that works better, hence its
# name.
-# CAVEAT: this script relies on the operation to run ignoring hidden
+# CAVEATS:
+# - this script relies on the operation to run ignoring hidden
# patches, so in 0.12 (where "stg push" can push an hidden patch)
# "stg-k push" will fail midway, albeit with no information loss -
-# you'll just have to finish manually. Luckilly this appears to work
-# on master branch.
+# you'll just have to finish manually. This is fixed in 0.13
+# - running this script to pop all patches in the stack fails, since
+# stg-unnew does not support this case.
# Copyright (c) 2007 Yann Dirson <ydirson@altern.org>
# Subject to the GNU GPL, version 2.
diff --git a/contrib/stg-unnew b/contrib/stg-unnew
index 5ac8781..2a38264 100755
--- a/contrib/stg-unnew
+++ b/contrib/stg-unnew
@@ -6,6 +6,9 @@ set -e
# Remove the current patch from the stack, keeping its contents as
# uncommitted changes.
+# CAVEAT: running this script on the bottom-most patch fails, since
+# "stg pick --fold" does not allow this situation.
+
# Copyright (c) 2007 Yann Dirson <ydirson@altern.org>
# Subject to the GNU GPL, version 2.
Yann Dirson <ydirson@altern.org>