nils/gluon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add a hint that 'make update' is only requiring an internet connection

Browse Source 
Add a hint to the development basics, about the consequences of calling 'make update' and why it has to be called explicitly.
This commit is contained in:
Sven Roederer 2021-05-06 23:12:23 +02:00 committed by Sven Roederer
parent 8279943882
commit 04aa445136
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/dev/basics.rst
View File

@ -37,6 +37,10 @@ rerun
`make update` also applies the patches that can be found in the directories found in `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` `patches`; the resulting branch will be called `patched`, while the commit specified in `modules`
can be referred to by the branch `base`. 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 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 since the base commit have been edited or removed), the patch directories can be regenerated