README_FIRST.txt

   1 Girocco README
   2 ==============
   3
   4 The "girocco" branch is maintained using TopGit.
   5
   6 It contains the version of gitweb used by Girocco
   7 and may be seen in action at <https://repo.or.cz/>.
   8
   9 TopGit is available from:
  10
  11   <https://repo.or.cz/topgit/pro.git>
  12
  13 TopGit version 0.19.13 or later is highly recommended.
  14
  15 Once TopGit is installed, the following will set up
  16 a local clone of the girocco gitweb repository for use
  17 with TopGit:
  18
  19     git clone https://repo.or.cz/girocco-gitweb.git
  20     cd girocco-gitweb
  21     tg remote --populate origin
  22     tg info
  23
  24 Use `tg help tg` for more information about TopGit.
  25
  26 Note that while the project name is 'girocco-gitweb' the entire
  27 Git repository is present even though differences from the
  28 main Git repository are limited to the gitweb subdirectory.
  29
  30 The "release" branch represents the base Git release which
  31 the Girocco-specific gitweb patches have been applied to.
  32 The corresponding Git release tag may be shown like so:
  33
  34     tg info --leaves release
  35
  36 The "release" branch should always point to a commit that
  37 has an official, signed Git release tag.  When Girocco
  38 updates to a newer Git release, the "release" branch is
  39 updated to point to that new release tag and then the
  40 `tg update girocco` command is run to update the "girocco"
  41 staging branch to reflect the change.
  42
  43 For example, to update to the Git release tagged as vX.X.X,
  44 the following procedure would be used:
  45
  46     tg update --base release vX.X.X
  47     tg update girocco
  48
  49 When `tg update girocco` runs it merges the updates
  50 throughout the network of topics that girocco depends on
  51 culminating in an update to the girocco topic itself.
  52 Along the way any conflicts will need to be resolved.
  53
  54 The `tg update girocco` process may take some time to run.
  55
  56 To see the list of topics that the girocco branch depends on
  57 and their relationships to one another run this command:
  58
  59     tg summary --rdeps --exclude=release girocco
  60
  61 (Since all of the topics ultimately depend on release,
  62 omitting those lines makes for a more useful display.)