[RFC PATCH 2/5] branch: document the usage of certain parameters

From

Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>

Date

Sep 19, 2017, 07:15 UTC

Message-ID

<20170919071525.9404-3-kaarticsivaraam91196@gmail.com>

In-Reply-To

<20170919071525.9404-1-kaarticsivaraam91196@gmail.com>

So, document them for the sake of completeness and easy reference.

Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
---
 branch.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/branch.h b/branch.h
index b07788558..33b7f5d88 100644
--- a/branch.h
+++ b/branch.h
@@ -15,6 +15,11 @@
  *
  *   - reflog creates a reflog for the branch
  *
+ *   - if 'force' is true, clobber_head indicates whether the branch could be
+ *     the current branch; else it has no effect
+ *
+ *   - quiet suppresses tracking information
+ *
  *   - track causes the new branch to be configured to merge the remote branch
  *     that start_name is a tracking branch for (if any).
  */

-- 
2.14.1.1006.g90ad9a07c