Document what a "bifurcation commit" is (fixes #84)

git-big-picture · Jan 19, 2021 · e0f816b · e0f816b
1 parent dc07c35
commit e0f816b
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -214,7 +214,11 @@ Usage
       -R, --no-roots        do not show root commits
       -m, --merges          include merge commits
       -M, --no-merges       do not include merge commits
-      -i, --bifurcations    include bifurcation commits
+      -i, --bifurcations    include bifurcation commits; a bifurcation commit is a
+                            commit that is a parent to more than one other commits,
+                            i.e. it marks the point where one or more new branches
+                            came to life; bifurcation commits can also be thought of
+                            as the counterpart of merge commits
       -I, --no-bifurcations
                             do not include bifurcation commits
       -c, --commit-messages

diff --git a/git-big-picture.1 b/git-big-picture.1
@@ -100,7 +100,11 @@ include merge commits
 do not include merge commits
 .TP
 \fB\-i\fR, \fB\-\-bifurcations\fR
-include bifurcation commits
+include bifurcation commits; a bifurcation commit is a
+commit that is a parent to more than one other commits,
+i.e. it marks the point where one or more new branches
+came to life; bifurcation commits can also be thought of
+as the counterpart of merge commits
 .TP
 \fB\-I\fR, \fB\-\-no\-bifurcations\fR
 do not include bifurcation commits

diff --git a/git_big_picture/_main.py b/git_big_picture/_main.py
@@ -284,7 +284,16 @@ def create_parser():
                               default=None,
                               action='store_true',
                               dest=BIFURCATIONS,
-                              help='include bifurcation commits')
+                              help='\n'.join(
+                                  textwrap.wrap(
+                                      'include bifurcation commits'
+                                      '; a bifurcation commit is a commit that '
+                                      'is a parent to more than one other commits, '
+                                      'i.e. it marks the point where one or more '
+                                      'new branches came to life; bifurcation '
+                                      'commits can also be thought of as the '
+                                      'counterpart of merge commits',
+                                      width=_RIGHT_COLUMN_WRAPT_WIDTH)))
     filter_group.add_argument('-I',
                               '--no-bifurcations',
                               default=None,