README.md

   1 # How to add this overlay to your Gentoo system
   2
   3 ```
   4 eselect repository enable gentoo-zh
   5 emerge --sync
   6 ```
   7
   8 # rule no.1
   9
  10 DO NOT BREAK PEOPLE'S SYSTEM
  11
  12 # rule no.2
  13
  14 DO NOT BREAK PEOPLE'S SYSTEM
  15
  16 # rule no.3
  17
  18 follow rule no.1 and no.2
  19
  20 # the dependencies table
  21
  22 https://github.com/microcai/gentoo-zh/blob/deps-table/relation.md
  23
  24 # commit message
  25
  26 * for non-version bump commit, commit message should be like this:
  27
  28         $category/$package: one line short description message
  29         {empty line}
  30         multiple lines of description about why you change this.
  31         if you change to fix the bug, and if there is an GitHub
  32         issue entry for that bug, then point the bug link here.
  33
  34 * for version bump commit, commit message should be like this:
  35
  36         $category/$package: version bump to $new_version
  37
  38 # package review
  39
  40 * I trust contributors that have commit rights, therefore commitors
  41   should think carefully before committing.
  42
  43 * If you want to discuss your commit/patch, push to *another branch* or send a
  44   Pull Request and discuss in the GitHub Issue, mailing list, or talk to the maintainer
  45   directly.
  46
  47 * If you are sending a new pull request, make sure it contains all necessary commits
  48   for a single contribution, e.g. don't send two pull requests for an ebuild and its
  49   `Manifest`.
  50
  51 * Every ebuild change should not produce compile error before
  52   committing.
  53
  54 * Every ebuild should be tested in every ARCH that it KEYWORDS for.
  55   if not, don't claim that you support that keyword.
  56
  57 * If you are writing the ebuild for a font, and you are using stantard font.eclass
  58   to install the font, I could grant an exception for the must-tested-in-every-ARCH
  59   rule. You could use something like
  60
  61   `KEYWORDS="alpha amd64 arm hppa ia64 ppc mips ~s390 ~sh sparc x86 ~x86-fbsd"`
  62
  63   But please don't abuse this exception. It must be a pure font package.
  64
  65 # Distfiles mirror
  66
  67 We provide a distfiles mirror that caches the distfiles in gentoo-zh.
  68
  69 Our server, hosted on Finland:
  70 ```
  71 GENTOO_MIRRORS="${GENTOO_MIRRORS} https://distfiles.gentoocn.org"
  72 ```
  73
  74 Chongqing University mirror:
  75 ```
  76 GENTOO_MIRRORS="${GENTOO_MIRRORS} https://mirrors.cqu.edu.cn/gentoo-zh"
  77 ```
  78
  79 Nanjing University mirror:
  80 ```
  81 GENTOO_MIRRORS="${GENTOO_MIRRORS} https://mirrors.nju.edu.cn/gentoo-zh"
  82 ```
  83
  84 # See wiki for some package not working