From be223cad78110944f302c43246a6bf2fe712fc67 Mon Sep 17 00:00:00 2001
From: Ben Widawsky <bwidawsk@FreeBSD.org>
Date: Thu, 2 Aug 2018 18:28:02 +0000
Subject: [PATCH] tools: Add a git-svn bootstrap script

codified version of https://wiki.freebsd.org/GitWorkflow/GitSvn#Using_git-svn

Approved by:	emaste (mentor)
Suggested by:	Warner Losh (imp)
Differential Revision:  https://reviews.freebsd.org/D16528
---
 .gitattributes               |   1 +
 tools/tools/git/HOWTO        |   7 ++
 tools/tools/git/git-svn-init | 195 +++++++++++++++++++++++++++++++++++
 3 files changed, 203 insertions(+)
 create mode 100755 tools/tools/git/git-svn-init

diff --git a/.gitattributes b/.gitattributes
index d3452fd3cef..ef16cae7375 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -3,3 +3,4 @@
 *.cpp  diff=cpp
 *.hpp  diff=cpp
 *.py   diff=python
+. svn-properties=svn:executable=tools/tools/git/git-svn-init
diff --git a/tools/tools/git/HOWTO b/tools/tools/git/HOWTO
index 48828e892a8..3e95264789f 100644
--- a/tools/tools/git/HOWTO
+++ b/tools/tools/git/HOWTO
@@ -157,3 +157,10 @@ and it will do its thing and leave the tree on the master branch.
 
 Your tree must be clean to start this, and while it tries to catch
 some failures, not all of them have been allowed for.
+
+IV. git-svn-init
+git-svn-init is a script that initializes the right git-svn connection as
+outlined in https://wiki.freebsd.org/GitWorkflow/GitSvn. It would be a precursor
+to the script git-svn-rebase. The script contains help, but generally you can
+run the script with no arguments and it will attempt to set up both src and
+ports repositories.
diff --git a/tools/tools/git/git-svn-init b/tools/tools/git/git-svn-init
new file mode 100755
index 00000000000..8b46dfc96ae
--- /dev/null
+++ b/tools/tools/git/git-svn-init
@@ -0,0 +1,195 @@
+#!/bin/sh
+
+# $FreeBSD$
+
+# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
+#
+#  Copyright(c) 2018 Intel Corporation.
+#
+#  Redistribution and use in source and binary forms, with or without
+#  modification, are permitted provided that the following conditions
+#  are met:
+#  1. Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#  2. Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+#  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+#  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+#  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+#  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+#  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+#  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+#  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+#  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#  SUCH DAMAGE.
+
+# This is the codified version of what was/is on the wiki page for using git in
+# your workflow. It sets up proper repositories, with the correct remotes.
+
+# Environment variables which can be overridden if desired. Not worth
+# parameterizing them.
+GIT_IN_PATH=$(which git)
+GIT=${GIT-${GIT_IN_PATH}}
+
+GIT_PORTS_REPO=${GIT_PORTS_REPO-git://github.com/freebsd/freebsd-ports.git}
+GIT_SVN_PORTS_ROOT_URI=${GIT_SVN_PORTS_ROOT_URI-svn.freebsd.org/ports}
+GIT_SVN_PORTS_URI=${GIT_SVN_PORTS_URI-repo.freebsd.org/ports}
+
+GIT_SRC_REPO=${GIT_SRC_REPO-git://github.com/freebsd/freebsd.git}
+GIT_SVN_SRC_ROOT_URI=${GIT_SVN_SRC_ROOT_URI-svn.freebsd.org/base}
+GIT_SVN_SRC_URI=${GIT_SVN_SRC_URI-repo.freebsd.org/base}
+
+GIT_SVN_PORTS_PUSH_URI=$GIT_SVN_PORTS_URI
+GIT_SVN_SRC_PUSH_URI=$GIT_SVN_SRC_URI
+
+usage()
+{
+	cat <<EOF
+Usage: git-svn-init: [-b base_path] [-n] [-p] [-s]
+
+git-svn-init will instantiate git repositories for src, and ports and connect
+them to the upstream SVN repository. By default it will attempt to do this for
+both ports and src under freebsd in the current working directory.
+-b	Base path for the clone operation (default: freebsd)
+-n	Dry run
+-p	Exclude ports
+-s	Exclude src
+
+EOF
+}
+
+clone()
+{
+	echo "Cloning ${3}"
+	${GIT} clone "$repo" -o upstream "$base"/${3}
+}
+
+svn_init()
+{
+	# init git-svn to point to the subversion repo:
+	${GIT} svn init -Thead --rewrite-root=svn+ssh://$1 svn+ssh://$2 .
+
+	# Replace to use upstream instead of the default origin
+	# TODO: Do this from git svn init
+	${GIT} config svn-remote.svn.fetch head:refs/remotes/upstream/trunk
+
+	# Committers need to use proper URL for dcommit
+	${GIT} config svn-remote.svn.pushurl svn+ssh://$3
+
+}
+
+svn_check()
+{
+	cat <<EOF
+[svn-remote "svn"]
+	url = svn+ssh://repo.freebsd.org/base
+	rewriteRoot = svn+ssh://svn.freebsd.org/base
+	pushurl = svn+ssh://repo.freebsd.org/base
+	fetch = head:refs/remotes/upstream/trunk
+EOF
+	[ -z ${DRY_RUN} ] && grep -A4 'svn-remote "svn"' .git/config
+}
+
+svn_connect()
+{
+	# Now make a git branch 'trunk' for git-svn to follow. What we want to
+	# do it set it to point to the final commit in upstream/svn_head.
+	local svn_head_sha=$(git show-ref upstream/svn_head|cut -d" " -f1)
+	${GIT} update-ref refs/remotes/upstream/trunk $svn_head_sha # git-svn really needs this branch
+}
+
+svn_fetch()
+{
+	${GIT} svn fetch
+}
+
+git_pulls()
+{
+	# Get pull requests from the repos:
+	${GIT} config --add remote.upstream.fetch '+refs/pull/*:refs/remotes/upstream/pull/*'
+	${GIT} fetch
+}
+
+git_checkout()
+{
+	# Arrange to have 'master' reference 'trunk'
+	${GIT} checkout trunk
+
+	# Delete master
+	${GIT} branch -D master
+
+	# Make master really be trunk
+	${GIT} checkout -b master trunk
+}
+
+rebase()
+{
+	${GIT} svn rebase
+}
+
+doit()
+{
+	local repo=${1}
+	local base=${2}
+
+	if [ "$3" = "src" ] ; then
+		local svn_root_uri=$GIT_SVN_SRC_ROOT_URI
+		local svn_uri=$GIT_SVN_SRC_URI
+		local svn_push_uri=$GIT_SVN_SRC_PUSH_URI
+	else
+		local svn_root_uri=$GIT_SVN_PORTS_ROOT_URI
+		local svn_uri=$GIT_SVN_PORTS_URI
+		local svn_push_uri=$GIT_SVN_PORTS_PUSH_URI
+	fi
+
+	clone ${repo} ${base} ${3}
+
+	cd "$base"/${3}
+	svn_init $svn_root_uri $svn_uri $svn_push_uri
+	svn_check $(basename $svn_uri) # get base or ports, not src/ports.
+	svn_connect
+	svn_fetch
+	git_pulls
+	git_checkout
+	rebase
+
+	cd -
+}
+
+ports=1
+source=1
+while getopts "hb:nr:sp" opt; do
+	case "$opt" in
+		b)
+			base_path="$OPTARG"
+			;;
+		n)
+			DRY_RUN=1
+			;;
+		p)
+			ports=0
+			;;
+		s)
+			source=0
+			;;
+		h|*)
+			usage
+			exit 0
+	esac
+done
+
+if [ ! -z "${DRY_RUN}" ] ; then
+	GIT='echo git'
+fi
+
+if [ "$source" -eq 1 ]; then
+	doit ${GIT_SRC_REPO} ${base_path:-freebsd} "src"
+fi
+
+if [ "$ports" -eq 1 ]; then
+	doit ${GIT_PORTS_REPO} ${base_path:-freebsd} "ports"
+fi
-- 
2.45.0