From 04aa4451367d3c3457283dbf180b02938b58cf63 Mon Sep 17 00:00:00 2001 From: Sven Roederer Date: Thu, 6 May 2021 23:12:23 +0200 Subject: [PATCH] docs: add a hint that 'make update' is only requiring an internet connection Add a hint to the development basics, about the consequences of calling 'make update' and why it has to be called explicitly. --- docs/dev/basics.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/dev/basics.rst b/docs/dev/basics.rst index a46baf71..497a5194 100644 --- a/docs/dev/basics.rst +++ b/docs/dev/basics.rst @@ -37,6 +37,10 @@ rerun `make update` also applies the patches that can be found in the directories found in `patches`; the resulting branch will be called `patched`, while the commit specified in `modules` can be referred to by the branch `base`. +To separately call `make update` was choosen, to let you decide when to update and reset the external +repos. This will prevent potential loss of commits during local development and allow building Gluon +without the need of having an internet connection (for sure the the 3rd-party sources must have been +downloaded already). After new patches have been committed on top of the `patched` branch (or existing commits since the base commit have been edited or removed), the patch directories can be regenerated