user-manual: use pithier example commit
[gitweb.git] / Documentation / merge-options.txt
index 53cc35590debbb7e4d7dfae536be19e59d038560..182cef54be5963ff0f32a24329ca195607413e29 100644 (file)
@@ -6,6 +6,14 @@
        not autocommit, to give the user a chance to inspect and
        further tweak the merge result before committing.
 
+--squash::
+       Produce the working tree and index state as if a real
+       merge happened, but do not actually make a commit or
+       move the `HEAD`, nor record `$GIT_DIR/MERGE_HEAD` to
+       cause the next `git commit` command to create a merge
+       commit.  This allows you to create a single commit on
+       top of the current branch whose effect is the same as
+       merging another branch (or more in case of an octopus).
 
 -s <strategy>, \--strategy=<strategy>::
        Use the given merge strategy; can be supplied more than