Updates for v2.1.0

jpgrayson · jpgrayson · commit 5818a8b4ec1d · 2022-12-12T11:30:35.000-05:00
diff --git a/content/_index.md b/content/_index.md
@@ -35,6 +35,25 @@ StGit is licensed under the GNU General Public License, version 2.
 
 ## News
 
+### 2022-12-12: [StGit v2.1.0][v2.1.0] has been released.
+
+This minor release introduces several long-awaited features, including
+some potentially breaking changes.
+
+The main breaking feature is relaxed stack initialization. Instead of
+needing to explicitly initialize a StGit stack on a branch, patch
+creating commands such as `stg new` and `stg import` will automatically
+initialize the stack, if needed. Most other commands that previously
+required an initialized stack will now operate as if there is an empty
+stack if the stack is not yet initialized.
+
+Another potentially breaking change is that the `stgit.gpgsign`
+configuration variable is now independent of `commit.gpgsign`. I.e. to
+have signed stack metadata commits, `stgit.gpgsign` must be set to
+`true`.
+
+See the [changelog](changelog/) for all the details on this release.
+
 ### 2022-11-30: [StGit v2.0.4][v2.0.4] has been released.
 
 This release makes some repairs to aliases, including documenting
@@ -114,6 +133,7 @@ Thanks to everyone who submitted a PR or reported an issue!
 
 See the [changelog](changelog/) for all the details on this release.
 
+[v2.1.0]: https://github.com/stacked-git/stgit/releases/tag/v2.1.0
 [v2.0.4]: https://github.com/stacked-git/stgit/releases/tag/v2.0.4
 [v2.0.3]: https://github.com/stacked-git/stgit/releases/tag/v2.0.3
 [v2.0.2]: https://github.com/stacked-git/stgit/releases/tag/v2.0.2
diff --git a/content/changelog/_index.md b/content/changelog/_index.md
@@ -4,6 +4,30 @@ title = 'StGit Changelog'
 
 # Changelog
 
+## [2.1.0] 2022-12-12
+
+### Added
+- feat: Configurable push conflict policy (#60)
+- feat: Add --committer-date-is-author-date option (#47)
+- feat(import): Add --3way option (#36)
+- feat(import): Add --directory option (#36)
+
+### Changed
+- feat!: Relaxed stack initialization (#238)
+- feat!: Only sign stack based on stgit.gpgsign (#238)
+- fix!: Allow "---" separator in messages (#243)
+- feat: More descriptive push conflict message (#60)
+- feat: Avoid post-edit commits when no change
+- chore: Update dependencies to latest versions
+
+### Fixed
+- fix: Improved error message for uninitialized stack
+- fix: Improve error for re-initialization attempt
+- fix(prev): Different error message for empty stack
+- fix: Accept full ref name for branches
+- fix(zsh): Complete --edit and --diff for stg new
+
+
 ## [2.0.4] 2022-11-30
 
 ### Changed
diff --git a/content/man/stg-delete.adoc b/content/man/stg-delete.adoc
@@ -37,6 +37,20 @@ This can be useful for splitting a patch into smaller pieces.
 --branch=<branch>::
     Use BRANCH instead of current branch
 
+--conflicts[=<policy>]::
+    Either "allow" or "disallow" pushing a patch with conflicts.
++
+Using `--conflicts=allow` (or just `--conflicts`) allows pushing a patch that
+may result in unresolved merge conflicts. The patch will be pushed and files
+with conflicts will be left with conflict markers to be resolved manually; or
+the operation undone with `stg undo --hard`. This is the default behavior and
+also corresponds to the "stgit.push.allow-conflicts" variable being set to "true".
++
+Using `--conflicts=disallow` disallows pushing any patch that would result in
+merge conflicts. The operation will stop on the last patch that can be pushed
+without conflicts. This behavior can be configured by setting
+"stgit.push.allow-conflicts" to "false".
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-edit.adoc b/content/man/stg-edit.adoc
@@ -87,6 +87,10 @@ option may be provided multiple times.
 +
 Use "now" to use the current time and date.
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 --save-template=<file>::
     Instead of running the command, just write the patch description to FILE,
     and exit. (If FILE is "-", write to stdout.)
diff --git a/content/man/stg-float.adoc b/content/man/stg-float.adoc
@@ -38,6 +38,10 @@ OPTIONS
 --keep::
     Keep the local changes
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-goto.adoc b/content/man/stg-goto.adoc
@@ -29,6 +29,24 @@ OPTIONS
 --merged::
     Check for patches merged upstream
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
+--conflicts[=<policy>]::
+    Either "allow" or "disallow" pushing a patch with conflicts.
++
+Using `--conflicts=allow` (or just `--conflicts`) allows pushing a patch that
+may result in unresolved merge conflicts. The patch will be pushed and files
+with conflicts will be left with conflict markers to be resolved manually; or
+the operation undone with `stg undo --hard`. This is the default behavior and
+also corresponds to the "stgit.push.allow-conflicts" variable being set to "true".
++
+Using `--conflicts=disallow` disallows pushing any patch that would result in
+merge conflicts. The operation will stop on the last patch that can be pushed
+without conflicts. This behavior can be configured by setting
+"stgit.push.allow-conflicts" to "false".
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-import.adoc b/content/man/stg-import.adoc
@@ -67,13 +67,22 @@ OPTIONS
 --strip=<n>::
     Remove <n> leading components from diff paths (default 1)
 
+--directory=<root>::
+    Prepend <root> to all filenames. If a "-p" argument is also passed, it is
+    applied before prepending the new root.
+
 -t::
 --stripname::
     Strip number and extension from patch name
 
 -C <n>::
     Ensure <n> lines of matching context for each change
 
+-3::
+--3way::
+    Attempt 3-way merge if the patch records the identity of blobs it is
+    supposed to apply to and those blobs are available locally.
+
 -i::
 --ignore::
     Ignore the applied patches in the series
@@ -140,6 +149,10 @@ option may be provided multiple times.
 +
 Use "now" to use the current time and date.
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-new.adoc b/content/man/stg-new.adoc
@@ -124,6 +124,10 @@ option may be provided multiple times.
 +
 Use "now" to use the current time and date.
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 --save-template=<file>::
     Instead of running the command, just write the patch description to FILE,
     and exit. (If FILE is "-", write to stdout.)
diff --git a/content/man/stg-pick.adoc b/content/man/stg-pick.adoc
@@ -57,6 +57,10 @@ OPTIONS
 --parent=<committish>::
     Use <committish> as parent
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 --fold::
     Fold the commit object into the current patch
 
diff --git a/content/man/stg-pull.adoc b/content/man/stg-pull.adoc
@@ -47,6 +47,20 @@ exist in the just-pulled upstream changes. If a patch's changes have already
 been merged upstream, the patch will still exist in the stack, but become empty
 after the pull operation.
 
+--conflicts[=<policy>]::
+    Either "allow" or "disallow" pushing a patch with conflicts.
++
+Using `--conflicts=allow` (or just `--conflicts`) allows pushing a patch that
+may result in unresolved merge conflicts. The patch will be pushed and files
+with conflicts will be left with conflict markers to be resolved manually; or
+the operation undone with `stg undo --hard`. This is the default behavior and
+also corresponds to the "stgit.push.allow-conflicts" variable being set to "true".
++
+Using `--conflicts=disallow` disallows pushing any patch that would result in
+merge conflicts. The operation will stop on the last patch that can be pushed
+without conflicts. This behavior can be configured by setting
+"stgit.push.allow-conflicts" to "false".
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-push.adoc b/content/man/stg-push.adoc
@@ -65,6 +65,24 @@ creating a new patch with some of the changes. Pushing the original patch with
 --merged::
     Check for patches merged upstream
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
+--conflicts[=<policy>]::
+    Either "allow" or "disallow" pushing a patch with conflicts.
++
+Using `--conflicts=allow` (or just `--conflicts`) allows pushing a patch that
+may result in unresolved merge conflicts. The patch will be pushed and files
+with conflicts will be left with conflict markers to be resolved manually; or
+the operation undone with `stg undo --hard`. This is the default behavior and
+also corresponds to the "stgit.push.allow-conflicts" variable being set to "true".
++
+Using `--conflicts=disallow` disallows pushing any patch that would result in
+merge conflicts. The operation will stop on the last patch that can be pushed
+without conflicts. This behavior can be configured by setting
+"stgit.push.allow-conflicts" to "false".
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-rebase.adoc b/content/man/stg-rebase.adoc
@@ -53,12 +53,30 @@ exist in the new stack base. If a patch's changes are detected to have been
 merged, the patch will still exist in the stack, but become empty after the
 rebase operation.
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 --autostash::
     Automatically create a temporary stash before the operation begins, and
     apply it after the operation completes. This allows a rebase to be
     performed on a dirty work tree. Note however that the final stash
     application may result in non-trivial conflicts.
 
+--conflicts[=<policy>]::
+    Either "allow" or "disallow" pushing a patch with conflicts.
++
+Using `--conflicts=allow` (or just `--conflicts`) allows pushing a patch that
+may result in unresolved merge conflicts. The patch will be pushed and files
+with conflicts will be left with conflict markers to be resolved manually; or
+the operation undone with `stg undo --hard`. This is the default behavior and
+also corresponds to the "stgit.push.allow-conflicts" variable being set to "true".
++
+Using `--conflicts=disallow` disallows pushing any patch that would result in
+merge conflicts. The operation will stop on the last patch that can be pushed
+without conflicts. This behavior can be configured by setting
+"stgit.push.allow-conflicts" to "false".
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-refresh.adoc b/content/man/stg-refresh.adoc
@@ -56,6 +56,20 @@ OPTIONS
     Instead of warning the user when some work has already been staged (such as
     with git add interactive mode) force a full refresh.
 
+--conflicts[=<policy>]::
+    Either "allow" or "disallow" pushing a patch with conflicts.
++
+Using `--conflicts=allow` (or just `--conflicts`) allows pushing a patch that
+may result in unresolved merge conflicts. The patch will be pushed and files
+with conflicts will be left with conflict markers to be resolved manually; or
+the operation undone with `stg undo --hard`. This is the default behavior and
+also corresponds to the "stgit.push.allow-conflicts" variable being set to "true".
++
+Using `--conflicts=disallow` disallows pushing any patch that would result in
+merge conflicts. The operation will stop on the last patch that can be pushed
+without conflicts. This behavior can be configured by setting
+"stgit.push.allow-conflicts" to "false".
+
 -p <patch>::
 --patch=<patch>::
     Refresh (applied) <patch> instead of the top patch
@@ -123,6 +137,10 @@ option may be provided multiple times.
 +
 Use "now" to use the current time and date.
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-sink.adoc b/content/man/stg-sink.adoc
@@ -49,6 +49,10 @@ Specified patches are placed below <target> instead of at the bottom of the stac
 --keep::
     Keep the local changes
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-spill.adoc b/content/man/stg-spill.adoc
@@ -35,6 +35,10 @@ OPTIONS
     worktree. Without this option, the patch's changes will be in both the
     index and worktree.
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg-squash.adoc b/content/man/stg-squash.adoc
@@ -93,6 +93,10 @@ option may be provided multiple times.
 +
 Use "now" to use the current time and date.
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 --save-template=<file>::
     Instead of running the command, just write the patch description to FILE,
     and exit. (If FILE is "-", write to stdout.)
diff --git a/content/man/stg-sync.adoc b/content/man/stg-sync.adoc
@@ -36,6 +36,10 @@ OPTIONS
 --series=<series>::
     Synchronize patches with <series>
 
+--committer-date-is-author-date::
+    Instead of using the current time as the committer date, use the author
+    date of the commit as the committer date.
+
 StGit
 -----
 Part of the StGit suite - see linkman:stg[1]
diff --git a/content/man/stg.adoc b/content/man/stg.adoc
@@ -251,12 +251,10 @@ stgit.fetchcmd::
   default command is `git fetch`.
 
 stgit.gpgsign::
-  A boolean to specify whether StGit stack metadata commits should be GPG signed. When
-  not set, the value of 'commit.gpgsign' is used. If neither 'stgit.gpgsign' or
-  'commit.gpgsign' are set, then stack metadata commits will not be signed.
+  A boolean to specify whether StGit stack metadata commits should be GPG signed.
 +
-N.B. Set 'commit.gpgsign' to determine whether patches themselves are GPG signed. See
-linkgit:git-config[1] for more information about 'commit.gpgsign'.
+N.B. Set 'commit.gpgsign' to determine whether patch commits themselves are GPG signed.
+See linkgit:git-config[1] for more information about 'commit.gpgsign'.
 
 stgit.import.message-id::
   When set to 'true', create 'Message-Id:' trailer in the patch description of patches
@@ -300,6 +298,21 @@ stgit.pullcmd::
   The command to be run by linkstg:pull[] to pull changes from the remote repository
   when 'stgit.pull-policy' is 'pull' (the default). The default value is `git pull`.
 
+stgit.push.allow-conflicts::
+  A boolean to specify whether linkstg:push[] and other commands that push patches will
+  push patches that may result in merge conflicts. The default is 'true', which means
+  that a patch with conflicts will be pushed and if the conflicts cannot be
+  automatically resolved, the operation will stop and with the conflicts left to be
+  resolved manually.
++
+When set to 'false', a patch that would have merge conflicts will not be pushed, thus
+leaving the stack on the last patch that could be pushed without conflicts.
++
+This configuration variable may be overridden on the command line with either
+`--conflicts[=allow]` or `--conflicts=disallow`.
++
+N.B.: 'stgit.autoimerge' only has an affect when push conflicts are allowed.
+
 stgit.rebasecmd::
   The command to be run by linkstg:pull[] to set the new stack base when
   'stgit.pull-policy' is either 'rebase' or 'fetch-rebase'. The default is `git reset
