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 <http://repo.or.cz/>.
   8
   9 TopGit is available from:
  10
  11   <http://repo.or.cz/topgit/pro.git>
  12
  13 TopGit version 0.19.12 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 -b girocco http://repo.or.cz/git/gitweb.git
  20     cd 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 'git/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
  33 The "release" branch should always point to a commit that
  34 has an official, signed Git release tag.  When Girocco
  35 updates to a newer Git release, the "release" branch is
  36 fast-forwarded to that new release tag and then the
  37 `tg update girocco` command is run to update the "girocco"
  38 staging branch to reflect the change.
  39
  40 For example, to update to the Git release tagged as vX.X.X,
  41 the following procedure would be used:
  42
  43     git update-ref refs/top-bases/release vX.X.X^0
  44     tg update girocco
  45
  46 When `tg update girocco` runs it will first merge
  47 refs/top-bases/release into refs/heads/release and then it
  48 will proceed to merge those updates throughout the network of
  49 topics that girocco depends on culminating in an update to
  50 the girocco topic itself.  Along the way any conflicts will
  51 need to be resolved.
  52
  53 The `tg update girocco` process may take some time to run.
  54
  55 To see the list of topics that the girocco branch depends on
  56 and their relationships to one another run this command:
  57
  58     tg summary --rdeps --exclude=release girocco
  59
  60 (Since all of the topics ultimately depend on release,
  61 omitting those lines makes for a more useful display.)