Add --file option

Allow the commit to be passed in as a file. Also added the option
of modifying the commit message for the push command.

Change-Id: Id8e245a80ad46d2a303b0e18739e40f4ba6f3f45

Author: admorgan

ReadMe.pod

@@ -128,7 +128,7 @@ all the same arguments. Keep reading…
 
 =over
 
-=item C<< git subrepo clone <repository> [<subdir>] [-b <branch>] [-f] [-m <msg>] [-e] [--method <merge|rebase>] >>
+=item C<< git subrepo clone <repository> [<subdir>] [-b <branch>] [-f] [-m <msg>] [--file=<msg file>] [-e] [--method <merge|rebase>] >>
 
 Add a repository as a subrepo in a subdir of your repository.
 
@@ -150,8 +150,8 @@ The C<--force> option will "reclone" (completely replace) an existing subdir.
 The C<--method> option will decide how the join process between branches are
 performed. The default option is merge.
 
-The C<clone> command accepts the C<--branch=> C<--edit>, C<--force> and C<--
-message=> options.
+The C<clone> command accepts the C<--branch=> C<--edit>, C<--file>, C<--force>
+and C<--message=> options.
 
 =item C<< git subrepo init <subdir> [-r <remote>] [-b <branch>] [--method <merge|rebase>] >>
 
@@ -160,15 +160,13 @@ Turn an existing subdirectory into a subrepo.
 If you want to expose a subdirectory of your project as a published subrepo,
 this command will do that. It will split out the content of a normal
 subdirectory into a branch and start tracking it as a subrepo. Afterwards your
-original repo will look exactly the same except that there will be a C<<
-<subdir>/.gitrepo >> file.
+original repo will look exactly the same except that there will be a C<<<subdir>/.gitrepo >> file.
 
 If you specify the C<--remote> (and optionally the C<--branch>) option, the
 values will be added to the C<< <subdir>/.gitrepo >> file. The C<--remote>
 option is the upstream URL, and the C<--branch> option is the upstream branch
 to push to. These values will be needed to do a C<git subrepo push> command,
-but they can be provided later on the C<push> command (and saved to C<<
-<subdir>/.gitrepo >> if you also specify the C<--update> option).
+but they can be provided later on the C<push> command (and saved to C<<<subdir>/.gitrepo >> if you also specify the C<--update> option).
 
 Note: You will need to create the empty upstream repo and push to it on your
       own, using C<< git subrepo push <subdir> >>.
@@ -178,7 +176,7 @@ performed. The default option is merge.
 
 The C<init> command accepts the C<--branch=> and C<--remote=> options.
 
-=item C<< git subrepo pull <subdir>|--all [-M|-R|-f] [-m <msg>] [-e] [-b <branch>] [-r <remote>] [-u] >>
+=item C<< git subrepo pull <subdir>|--all [-M|-R|-f] [-m <msg>] [--file=<msg file>] [-e] [-b <branch>] [-r <remote>] [-u] >>
 
 Update the subrepo subdir with the latest upstream changes.
 
@@ -223,10 +221,10 @@ clean. You can easily see the subrepo's history with the C<git log> command:
 
 The set of commands used above are described in detail below.
 
-The C<pull> command accepts the C<--all>, C<--branch=>, C<--edit>, C<--force>,
-C<--message=>, C<--remote=> and C<--update> options.
+The C<pull> command accepts the C<--all>, C<--branch=>, C<--edit>, C<--file>,
+C<--force>, C<--message=>, C<--remote=> and C<--update> options.
 
-=item C<< git subrepo push <subdir>|--all [<branch>] [-r <remote>] [-b <branch>] [-M|-R] [-u] [-f] [-s] [-N] >>
+=item C<< git subrepo push <subdir>|--all [<branch>] [-m msg] [--file=<msg file>] [-r <remote>] [-b <branch>] [-M|-R] [-u] [-f] [-s] [-N] >>
 
 Push a properly merged subrepo branch back upstream.
 
@@ -250,9 +248,7 @@ The C<--force> option will do a force push. Force pushes are typically
 discouraged. Only use this option if you fully understand it. (The C<--force>
 option will NOT check for a proper merge. ANY branch will be force pushed!)
 
-The C<push> command accepts the C<--all>, C<--branch=>, C<--dry-run>, C<--
-force>, C<--merge>, C<--rebase>, C<--remote=>, C<--squash> and C<--
-update> options.
+The C<push> command accepts the C<--all>, C<--branch=>, C<--dry-run>, C<--file>, C<--force>, C<--merge>, C<--message>, C<--rebase>, C<--remote=>, C<--squash> and C<--update> options.
 
 =item C<< git subrepo fetch <subdir>|--all [-r <remote>] [-b <branch>] >>
 
@@ -263,8 +259,7 @@ points at the same commit as C<FETCH_HEAD>. It will also create a remote
 called C<< subrepo/<subdir> >>. These are temporary and you can easily remove
 them with the subrepo C<clean> command.
 
-The C<fetch> command accepts the C<--all>, C<--branch=> and C<--
-remote=> options.
+The C<fetch> command accepts the C<--all>, C<--branch=> and C<--remote=> options.
 
 =item C<< git subrepo branch <subdir>|--all [-f] [-F] >>
 
@@ -280,26 +275,24 @@ Use the C<--force> option to write over an existing C<< subrepo/<subdir>
 
 The C<branch> command accepts the C<--all>, C<--fetch> and C<--force> options.
 
-=item C<< git subrepo commit <subdir> [<subrepo-ref>] [-m <msg>] [-e] [-f] [-F] >>
+=item C<< git subrepo commit <subdir> [<subrepo-ref>] [-m <msg>] [--file=<msg file>] [-e] [-f] [-F] >>
 
 Add subrepo branch to current history as a single commit.
 
-This command is generally used after a hand-merge. You have done a C<subrepo
-branch> and merged (rebased) it with the upstream. This command takes the HEAD
+This command is generally used after a hand-merge. You have done a C<subrepobranch> and merged (rebased) it with the upstream. This command takes the HEAD
 of that branch, puts its content into the subrepo subdir and adds a new commit
 for it to the top of your mainline history.
 
 This command requires that the upstream HEAD be in the C<< subrepo/<subdir> >>
 branch history. That way the same branch can push upstream. Use the C<--force>
 option to commit anyway.
 
-The C<commit> command accepts the C<--edit>, C<--fetch>, C<--force> and C<--
-message=> options.
+The C<commit> command accepts the C<--edit>, C<--fetch>, C<--file>, C<--force>
+and C<--message=> options.
 
 =item C<< git subrepo status [<subdir>|--all|--ALL] [-F] [-q|-v] >>
 
-Get the status of a subrepo. Uses the C<--all> option by default. If the C<--
-quiet> flag is used, just print the subrepo names, one per line.
+Get the status of a subrepo. Uses the C<--all> option by default. If the C<--quiet> flag is used, just print the subrepo names, one per line.
 
 The C<--verbose> option will show all the recent local and upstream commits.
 
@@ -416,6 +409,10 @@ Edit the commit message before committing.
 
 Use this option to fetch the upstream commits, before running the command.
 
+=item C<< --file=<commit msg file> >>
+
+Supply your own commit message from a file
+
 =item C<--force> (C<-f>)
 
 Use this option to force certain commands that fail in the general case.
@@ -486,8 +483,7 @@ The C<git-subrepo> command exports and honors some environment variables:
 
 =item C<GIT_SUBREPO_ROOT>
 
-This is set by the C<.rc> file, if you use that method to install / enable C<git-
-subrepo>. It contains the path of the C<git-subrepo> repository.
+This is set by the C<.rc> file, if you use that method to install / enable C<git-subrepo>. It contains the path of the C<git-subrepo> repository.
 
 =item C<GIT_SUBREPO_RUNNING>
 

doc/git-subrepo.swim

@@ -88,7 +88,7 @@ experienced Git users.
 Please note that the commands are /not/ exact equivalents, and do not take all
 the same arguments. Keep reading…
 
-- `git subrepo clone <repository> [<subdir>] [-b <branch>] [-f] [-m <msg>] [-e] [--method <merge|rebase>]`
+- `git subrepo clone <repository> [<subdir>] [-b <branch>] [-f] [-m <msg>] [--file=<msg file>] [-e] [--method <merge|rebase>]`
 
   Add a repository as a subrepo in a subdir of your repository.
 
@@ -110,8 +110,8 @@ the same arguments. Keep reading…
   The `--method` option will decide how the join process between branches are
    performed. The default option is merge.
 
-  The `clone` command accepts the `--branch=` `--edit`, `--force` and
-  `--message=` options.
+  The `clone` command accepts the `--branch=` `--edit`, `--file`, `--force`
+  and `--message=` options.
 
 - `git subrepo init <subdir> [-r <remote>] [-b <branch>] [--method <merge|rebase>]`
 
@@ -126,7 +126,7 @@ the same arguments. Keep reading…
   If you specify the `--remote` (and optionally the `--branch`) option, the
   values will be added to the `<subdir>/.gitrepo` file. The `--remote` option
   is the upstream URL, and the `--branch` option is the upstream branch to push
-  to. These values will be needed to do a `git subrepo push` command, but they
+  to. These values will be needed to do a `git subrepo push` command, but they
   can be provided later on the `push` command (and saved to `<subdir>/.gitrepo`
   if you also specify the `--update` option).
 
@@ -138,7 +138,7 @@ the same arguments. Keep reading…
 
   The `init` command accepts the `--branch=` and `--remote=` options.
 
-- `git subrepo pull <subdir>|--all [-M|-R|-f] [-m <msg>] [-e] [-b <branch>] [-r <remote>] [-u]`
+- `git subrepo pull <subdir>|--all [-M|-R|-f] [-m <msg>] [--file=<msg file>] [-e] [-b <branch>] [-r <remote>] [-u]`
 
   Update the subrepo subdir with the latest upstream changes.
 
@@ -183,10 +183,10 @@ the same arguments. Keep reading…
 
   The set of commands used above are described in detail below.
 
-  The `pull` command accepts the `--all`, `--branch=`, `--edit`, `--force`,
-  `--message=`, `--remote=` and `--update` options.
+  The `pull` command accepts the `--all`, `--branch=`, `--edit`, `--file`,
+  `--force`, `--message=`, `--remote=` and `--update` options.
 
-- `git subrepo push <subdir>|--all [<branch>] [-r <remote>] [-b <branch>] [-M|-R] [-u] [-f] [-s] [-N]`
+- `git subrepo push <subdir>|--all [<branch>] [-m msg] [--file=<msg file>] [-r <remote>] [-b <branch>] [-M|-R] [-u] [-f] [-s] [-N]`
 
   Push a properly merged subrepo branch back upstream.
 
@@ -210,8 +210,9 @@ the same arguments. Keep reading…
   discouraged. Only use this option if you fully understand it. (The `--force`
   option will NOT check for a proper merge. ANY branch will be force pushed!)
 
-  The `push` command accepts the `--all`, `--branch=`, `--dry-run`, `--force`,
-  `--merge`, `--rebase`, `--remote=`, `--squash` and `--update` options.
+  The `push` command accepts the `--all`, `--branch=`, `--dry-run`, `--file`,
+  `--force`, `--merge`, `--message`, `--rebase`, `--remote=`, `--squash` and
+  `--update` options.
 
 - `git subrepo fetch <subdir>|--all [-r <remote>] [-b <branch>]`
 
@@ -237,7 +238,7 @@ the same arguments. Keep reading…
 
   The `branch` command accepts the `--all`, `--fetch` and `--force` options.
 
-- `git subrepo commit <subdir> [<subrepo-ref>] [-m <msg>] [-e] [-f] [-F]`
+- `git subrepo commit <subdir> [<subrepo-ref>] [-m <msg>] [--file=<msg file>] [-e] [-f] [-F]`
 
   Add subrepo branch to current history as a single commit.
 
@@ -250,8 +251,8 @@ the same arguments. Keep reading…
   branch history. That way the same branch can push upstream. Use the
   `--force` option to commit anyway.
 
-  The `commit` command accepts the `--edit`, `--fetch`, `--force` and
-  `--message=` options.
+  The `commit` command accepts the `--edit`, `--fetch`, `--file`, `--force`
+  and `--message=` options.
 
 - `git subrepo status [<subdir>|--all|--ALL] [-F] [-q|-v]`
 
@@ -368,6 +369,10 @@ the same arguments. Keep reading…
 
   Use this option to fetch the upstream commits, before running the command.
 
+- `--file=<commit msg file>`
+
+  Supply your own commit message from a file
+
 - `--force` (`-f`)
 
   Use this option to force certain commands that fail in the general case.

lib/git-subrepo

@@ -73,6 +73,7 @@ f,force     Force certain operations
 F,fetch     Fetch the upstream content first
 M,method=   Join method: 'merge' (default) or 'rebase'
 m,message=  Specify a commit message
+file=       Specify a commit message file
 r,remote=   Specify the upstream remote to push/pull/fetch
 s,squash    Squash commits on push
 u,update    Add the --branch and/or --remote overrides to .gitrepo
@@ -131,6 +132,7 @@ main() {
 
   local edit_wanted=false       # Edit commit message using -e
   local wanted_commit_message=  # Custom commit message using -m
+  local commit_msg_file=        # Custom commit message using --file
 
   local join_method=            # Current join method (rebase/merge)
 
@@ -685,7 +687,19 @@ subrepo:push() {
   upstream_head_commit=$new_upstream_head_commit
   subrepo_commit_ref=$upstream_head_commit
   update-gitrepo-file
-  RUN git commit -m "$(get-commit-message)"
+
+  local commit_message
+  if [[ $wanted_commit_message ]]; then
+    commit_message=$wanted_commit_message
+  else
+    commit_message=$(get-commit-message)
+  fi
+
+  if [[ $commit_msg_file ]]; then
+    RUN git command --file "$commit_msg_file"
+  else
+    RUN git commit -m "$commit_message"
+  fi
 }
 
 # Fetch the subrepo's remote branch content:
@@ -872,13 +886,21 @@ subrepo:commit() {
 
   o "Commit to the '$original_head_branch' branch."
   if [[ $original_head_commit != none ]]; then
-    RUN git commit $edit_flag -m "$commit_message"
+    if [[ $commit_msg_file ]]; then
+      RUN git commit $edit_flag --file "$commit_msg_file"
+    else
+      RUN git commit $edit_flag -m "$commit_message"
+    fi
   else
     # We had cloned into an empty repo, side effect of prior git reset --mixed
     # command is that subrepo's history is now part of the index. Commit
     # without that history.
     OUT=true RUN git write-tree
-    OUT=true RUN git commit-tree $edit_flag -m "$commit_message" "$output"
+    if [[ $commit_msg_file ]]; then
+      OUT=true RUN git commit-tree $edit_flag --file "$commit_msg_file" "$output"
+    else
+      OUT=true RUN git commit-tree $edit_flag -m "$commit_message" "$output"
+    fi
     RUN git reset --hard "$output"
   fi
 
@@ -1039,7 +1061,11 @@ get-command-options() {
       -f) force_wanted=true
           commit_msg_args+=("--force") ;;
       -F) fetch_wanted=true ;;
-      -m) wanted_commit_message=$1
+      -m)
+          if [[ $commit_msg_file ]]; then
+            error "fatal: options '-m' and '--file' cannot be used together"
+          fi
+          wanted_commit_message=$1
           shift;;
       -M) join_method=$1
           shift;;
@@ -1054,6 +1080,16 @@ get-command-options() {
       -v) verbose_wanted=true ;;
       -d) debug_wanted=true ;;
       -x) set -x ;;
+      --file)
+        if [[ $wanted_commit_message ]]; then
+          error "fatal: options '-m' and '--file' cannot be used together"
+        fi
+        if [ -f "$1" ]; then
+          commit_msg_file="$1"
+        else
+          error "Commit msg file at $1 not found"
+        fi
+        shift ;;
       --version)
         echo "$VERSION"
         exit ;;
@@ -1089,7 +1125,7 @@ get-command-options() {
   if [[ $override_remote ]]; then
     check_option remote
   fi
-  if [[ $wanted_commit_message ]]; then
+  if [[ $wanted_commit_message || $commit_msg_file ]]; then
     check_option message
   fi
   if $update_wanted; then
@@ -1109,7 +1145,7 @@ options_commit='edit fetch force message'
 options_fetch='all branch remote'
 options_init='branch remote method'
 options_pull='all branch edit force message remote update'
-options_push='all branch force remote squash update'
+options_push='all branch force message remote squash update'
 options_status='ALL all fetch'
 check_option() {
   local var=options_${command//-/_}