Configuration doc added

This commit is contained in:
Christos Choutouridis 2025-06-27 14:18:57 +03:00
parent eebe11901d
commit 6a0c8db0b9

View File

@ -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/
#