basics.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. Development Basics
  2. ==================
  3. Gluon's source is kept in `git repositories`_ at GitHub.
  4. .. _git repositories: https://github.com/freifunk-gluon
  5. Bug Tracker
  6. -----------
  7. The `main repo`_ does have issues enabled.
  8. .. _main repo: https://github.com/freifunk-gluon/gluon
  9. IRC
  10. ---
  11. Gluon's developers frequent `#gluon on hackint`_. You're welcome to join us!
  12. .. _#gluon on hackint: irc://irc.hackint.org/#gluon
  13. Working with repositories
  14. -------------------------
  15. To update the repositories used by Gluon, just adjust the commit IDs in `modules` and
  16. rerun
  17. ::
  18. make update
  19. `make update` also applies the patches that can be found in the directories found in
  20. `patches`; the resulting branch will be called `patched`, while the commit specified in `modules`
  21. can be refered to by the branch `base`.
  22. ::
  23. make unpatch
  24. sets the repositories to the `base` branch,
  25. ::
  26. make patch
  27. re-applies the patches by resetting the `patched` branch to `base` and calling `git am`
  28. for the patch files. Calling `make` or a similar command after calling `make unpatch`
  29. is generally not a good idea.
  30. After new patches have been commited on top of the patched branch (or existing commits
  31. since the base commit have been edited or removed), the patch directories can be regenerated
  32. using
  33. ::
  34. make update-patches
  35. If applying a patch fails because you have changed the base commit, the repository will be reset to the old `patched` branch
  36. and you can try rebasing it onto the new `base` branch yourself and after that call `make update-patches` to fix the problem.
  37. Always call `make update-patches` after making changes to a module repository as `make update` will overwrite your
  38. commits, making `git reflog` the only way to recover them!