diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index eee5c75674b5321917ad0f6ca1fd005f213b155a..516f7803f9f09f3507aca9988badb44b8384c41e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,6 +5,16 @@ Instead we host a public gerrit server.
https://gerrit-ring.savoirfairelinux.com
+Before submitting a contribution, you need to register on it, either
+with your Github or Google account.
+Head to the settings section to either set:
+
+Http password and username
+ https://gerrit-ring.savoirfairelinux.com/#/settings/http-password
+
+Ssh key
+ https://gerrit-ring.savoirfairelinux.com/#/settings/ssh-keys
+
More documentation on Gerrit:
https://www.gerritcodereview.com/
diff --git a/README.md b/README.md
index 5ccb85c5851a9f3c1b035de40450ae92188ce537..5b9323d0c54b91378417f869e25ae5c1f1ccfa67 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,14 @@
Synchronization via submodules of the repositories of <https://ring.cx/> to states in which they work together + scripts to build for each platform easily.
-## First thing first
-
- git submodule update --init
-
## Install python3
Ring installer uses python3. Please make sure it is installed before running it.
+## First things first
+
+ ./make-ring.py --init
+
## On Linux
#### Build and install all the dependencies:
diff --git a/make-ring.py b/make-ring.py
index 3d4c4e125867f3dd9432018b4fee87f6a2c0e965..db2dc31a39298104473eec51e754d4ccd2317dd2 100755
--- a/make-ring.py
+++ b/make-ring.py
@@ -13,6 +13,7 @@ import sys
import time
import platform
import multiprocessing
+import shutil
DEBIAN_BASED_DISTROS = [
'Debian',
@@ -131,6 +132,22 @@ def run_dependencies(args):
print("Not yet implemented for current distribution (%s)" % args.distribution)
sys.exit(1)
+def run_init():
+ os.system("git submodule update --init")
+ os.system("git submodule foreach 'git checkout master && git pull'")
+ for project in ["daemon", "lrc", "client-macosx", "client-gnome", "client-android"]:
+ copy_file("./scripts/commit-msg", ".git/modules/"+project+"/hooks")
+
+def copy_file(src, dest):
+ print("Copying:" + src + " to " + dest)
+ try:
+ shutil.copy2(src, dest)
+ # eg. src and dest are the same file
+ except shutil.Error as e:
+ print('Error: %s' % e)
+ # eg. source or destination doesn't exist
+ except IOError as e:
+ print('Error: %s' % e.strerror)
def run_install(args):
install_args = ' -p ' + str(multiprocessing.cpu_count())
@@ -255,6 +272,9 @@ def parse_args():
ap = argparse.ArgumentParser(description="Ring build tool")
ga = ap.add_mutually_exclusive_group(required=True)
+ ga.add_argument(
+ '--init', action='store_true',
+ help='Init Ring repository')
ga.add_argument(
'--dependencies', action='store_true',
help='Install ring build dependencies')
@@ -306,6 +326,9 @@ def main():
if parsed_args.dependencies:
run_dependencies(parsed_args)
+ elif parsed_args.init:
+ run_init()
+
elif parsed_args.install:
run_install(parsed_args)
diff --git a/scripts/commit-msg b/scripts/commit-msg
new file mode 100755
index 0000000000000000000000000000000000000000..81edbe8c91aeaa3816d47cc127319f271414506c
--- /dev/null
+++ b/scripts/commit-msg
@@ -0,0 +1,181 @@
+#!/bin/sh
+# From Gerrit Code Review 2.11.3
+#
+# Part of Gerrit Code Review (http://code.google.com/p/gerrit/)
+#
+# Copyright (C) 2009 The Android Open Source Project
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+unset GREP_OPTIONS
+
+CHANGE_ID_AFTER="Bug|Issue"
+MSG="$1"
+
+# Check for, and add if missing, a unique Change-Id
+#
+add_ChangeId() {
+ clean_message=`sed -e '
+ /^diff --git .*/{
+ s///
+ q
+ }
+ /^Signed-off-by:/d
+ /^#/d
+ ' "$MSG" | git stripspace`
+ if test -z "$clean_message"
+ then
+ return
+ fi
+
+ if test "false" = "`git config --bool --get gerrit.createChangeId`"
+ then
+ return
+ fi
+
+ # Does Change-Id: already exist? if so, exit (no change).
+ if grep -i '^Change-Id:' "$MSG" >/dev/null
+ then
+ return
+ fi
+
+ id=`_gen_ChangeId`
+ T="$MSG.tmp.$$"
+ AWK=awk
+ if [ -x /usr/xpg4/bin/awk ]; then
+ # Solaris AWK is just too broken
+ AWK=/usr/xpg4/bin/awk
+ fi
+
+ # How this works:
+ # - parse the commit message as (textLine+ blankLine*)*
+ # - assume textLine+ to be a footer until proven otherwise
+ # - exception: the first block is not footer (as it is the title)
+ # - read textLine+ into a variable
+ # - then count blankLines
+ # - once the next textLine appears, print textLine+ blankLine* as these
+ # aren't footer
+ # - in END, the last textLine+ block is available for footer parsing
+ $AWK '
+ BEGIN {
+ # while we start with the assumption that textLine+
+ # is a footer, the first block is not.
+ isFooter = 0
+ footerComment = 0
+ blankLines = 0
+ }
+
+ # Skip lines starting with "#" without any spaces before it.
+ /^#/ { next }
+
+ # Skip the line starting with the diff command and everything after it,
+ # up to the end of the file, assuming it is only patch data.
+ # If more than one line before the diff was empty, strip all but one.
+ /^diff --git / {
+ blankLines = 0
+ while (getline) { }
+ next
+ }
+
+ # Count blank lines outside footer comments
+ /^$/ && (footerComment == 0) {
+ blankLines++
+ next
+ }
+
+ # Catch footer comment
+ /^\[[a-zA-Z0-9-]+:/ && (isFooter == 1) {
+ footerComment = 1
+ }
+
+ /]$/ && (footerComment == 1) {
+ footerComment = 2
+ }
+
+ # We have a non-blank line after blank lines. Handle this.
+ (blankLines > 0) {
+ print lines
+ for (i = 0; i < blankLines; i++) {
+ print ""
+ }
+
+ lines = ""
+ blankLines = 0
+ isFooter = 1
+ footerComment = 0
+ }
+
+ # Detect that the current block is not the footer
+ (footerComment == 0) && (!/^\[?[a-zA-Z0-9-]+:/ || /^[a-zA-Z0-9-]+:\/\//) {
+ isFooter = 0
+ }
+
+ {
+ # We need this information about the current last comment line
+ if (footerComment == 2) {
+ footerComment = 0
+ }
+ if (lines != "") {
+ lines = lines "\n";
+ }
+ lines = lines $0
+ }
+
+ # Footer handling:
+ # If the last block is considered a footer, splice in the Change-Id at the
+ # right place.
+ # Look for the right place to inject Change-Id by considering
+ # CHANGE_ID_AFTER. Keys listed in it (case insensitive) come first,
+ # then Change-Id, then everything else (eg. Signed-off-by:).
+ #
+ # Otherwise just print the last block, a new line and the Change-Id as a
+ # block of its own.
+ END {
+ unprinted = 1
+ if (isFooter == 0) {
+ print lines "\n"
+ lines = ""
+ }
+ changeIdAfter = "^(" tolower("'"$CHANGE_ID_AFTER"'") "):"
+ numlines = split(lines, footer, "\n")
+ for (line = 1; line <= numlines; line++) {
+ if (unprinted && match(tolower(footer[line]), changeIdAfter) != 1) {
+ unprinted = 0
+ print "Change-Id: I'"$id"'"
+ }
+ print footer[line]
+ }
+ if (unprinted) {
+ print "Change-Id: I'"$id"'"
+ }
+ }' "$MSG" > "$T" && mv "$T" "$MSG" || rm -f "$T"
+}
+_gen_ChangeIdInput() {
+ echo "tree `git write-tree`"
+ if parent=`git rev-parse "HEAD^0" 2>/dev/null`
+ then
+ echo "parent $parent"
+ fi
+ echo "author `git var GIT_AUTHOR_IDENT`"
+ echo "committer `git var GIT_COMMITTER_IDENT`"
+ echo
+ printf '%s' "$clean_message"
+}
+_gen_ChangeId() {
+ _gen_ChangeIdInput |
+ git hash-object -t commit --stdin
+}
+
+
+add_ChangeId