From 2cb5dfd603bfab21b3248cd7cde4ff34129d6393 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Bar=C4=87?= Date: Sun, 4 Oct 2020 18:30:20 +0200 Subject: [PATCH] contributing: update notice about failing sync --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99efa5b..681d7ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing +# Contributing ## How to contribute @@ -89,7 +89,11 @@ sync-type = git sync-uri = git@gitlab.com:src_prepare/src_prepare-overlay.git sync-user = :portage ``` -If you dont have write access to the cloned branch yet use "sync-uri = https://gitlab.com/src_prepare/src_prepare-overlay.git" instead. +If you don't have write access to the cloned branch yet use "sync-uri = https://gitlab.com/src_prepare/src_prepare-overlay.git" instead. + +If you lock your SSH key with a password autosyncing may fail. +To evade that use "auto-sync = no" and pull the changes manually (or using a different tool other than 'emerge --sync' or 'eix-sync'). +Either way, remember that if you pull with a user different than the sync will fail (because that user likely won't have the SSH keys). ### Sync the overlay As root