From 6a0c8db0b99bebc74114cb19897a427c26e8de1b Mon Sep 17 00:00:00 2001 From: Christos Choutouridis Date: Fri, 27 Jun 2025 14:18:57 +0300 Subject: [PATCH] Configuration doc added --- repos.conf | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/repos.conf b/repos.conf index 09f669b..7c65d10 100644 --- a/repos.conf +++ b/repos.conf @@ -1,8 +1,32 @@ # # git-synchro configuration file # -# format: +# Pair lines to configure a link between two servers with their remote references and repo URLs. +# The server nicknames act as given names to each of the repo-urls in order to select them as +# from or to on every sync. +# +# Format: # repo-nickname; server-nickname; repo-remote; repo-url; directory # +# repo-nickname: A name to refer to the repo (used for display purposes) +# server-nickname: The name to use for server in --from and --to +# repo-remote: The name given as remote for each repository for each server +# repo-url: The url of the above remote +# directory: Full path to the local directory +# +# for ex: +# $ pwd +# /local/path/ +# $ git remote -v +# rem1 ssh://git@git.srv1.net/path/repo-name.git (fetch) +# rem1 ssh://git@git.srv1.net/path/repo-name.git (push) +# rem2 git@gitlab.srv2.com:path/repo-name.git (fetch) +# rem2 git@gitlab.srv2.com:path/repo-name.git (push) +# +# Has a conf pair as follows: +# +# a-name; srv1 ; rem1 ; ssh://git@git.srv1.net/path/repo-name.git ; /local/path/ +# a-name; srv2 ; rem2 ; git@gitlab.srv2.com:path/repo-name.git ; /local/path/ +#