pidgin/nest

Add some stuff on how the repositories are setup

2019-01-31, Gary Kramlich
71e43afb0d22
Parents 04ac25cbc1a6
Children b6716abb9908
Add some stuff on how the repositories are setup
3 files changed, 79 insertions(+), 1 deletions(-)
  • +1 -1
    hugo/content/contributing/_index.md
  • +56 -0
    hugo/content/contributing/mercurial.md
  • +22 -0
    hugo/content/development/version-control.md
    • --- a/hugo/content/contributing/_index.md Thu Jan 31 21:30:38 2019 -0600
    +++ b/hugo/content/contributing/_index.md Thu Jan 31 23:09:48 2019 -0600
    @@ -17,7 +17,7 @@
    * mailing lists
    * support@pidgin.im
    * devel@pidgin.im
    - * proofread the documentation
    + * proofread the documentation
    * help facilitate translators
    * via [transifex](https://www.transifex.com/pidgin/pidgin/)
    * help translate this repo
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/hugo/content/contributing/mercurial.md Thu Jan 31 23:09:48 2019 -0600
    @@ -0,0 +1,56 @@
    +---
    +title: "Using Mercurial"
    +date: 2019-02-01T03:51:53+00:00
    +anchor: "contributing"
    +replaces: [
    + "developer.pidgin.im/wiki/UsingPidginMercurial",
    +]
    +---
    +
    +### Configure Mercurial
    +Mercurial is configured through serveral rc files. You can override the system-wide settings on a per-user or per-repository basis by changing either `~/.hgrc` or `<repository>/.hg/hgrc`. See `man hgrc` for details.
    +
    +You must set your username when working with Mercurial repositories. To do that, add two lines to `~/.hgrc` (or optionally `<repository>/.hg/hgrc`, if you want to use a different username for other Mercurial repositories):
    +
    +```
    +[ui]
    +username = First Last <email@address.tld>
    +```
    +
    +Other useful options that can be set in the `[ui]` section of an `hgrc` are the merge tool and to make Mercurial verbose or not:
    +
    +```
    +[ui]
    +username = First Last <email@address.tld>
    +verbose = True
    +merge = meld
    +```
    +
    +Git diffs can be useful too, and making `hg log -v` the default behavior for `hg log` can be helpful:
    +
    +```
    +[diff]
    +git = True
    +
    +[defaults]
    +log = -v
    +```
    +
    +### Clone the Repository and Select a Branch
    +
    +To start working with Pidgin from Mercurial, you'll probably want to clone our main repository:
    +
    +```
    +hg clone https://bitbucket.org/pidgin/main pidgin
    +```
    +
    +This will give you a `pidgin` directory with the 3.0.0 development code by default. If you want to develop against Pidgin 3.0.0, you're all set!
    +
    +Naturally, Pidgin has a number of branches within its repository, and these branches handle various projects including our maintenance of Pidgin 2.x.y. We won't go into all the branches here, as there are a lot of them, but we know some people would like to work against Pidgin 2.x.y instead of 3.0.0. In order to do that, clone the repository as above, but then do this:
    +
    +```
    +cd pidgin
    +hg up release-2.x.y
    +```
    +
    +You now have a Pidgin 2 tree to work with. Happy hacking!
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/hugo/content/development/version-control.md Thu Jan 31 23:09:48 2019 -0600
    @@ -0,0 +1,22 @@
    +---
    +title: "Version Control"
    +date: 2019-02-01T03:51:53+00:00
    +anchor: "development"
    +replaces: [
    + "developer.pidgin.im/wiki/UsingPidginMercurial",
    +]
    +---
    +
    +All of the source code relating to Pidgin and its libraries is hosted on
    +[bitbucket.org](https://bitbucket.org) in [mercurial](https://www.mercurial-scm.org/) repositories at
    +[bitbucket.org/pidgin](https://bitbucket.org/pidgin).
    +
    +### Repositories
    +
    +Pidgin itself lives in the [bitbucket.org/pidgin/main](https://bitbucket.org/pidgin/main) repository. This include Pidgin 2 on the `release-2.x.y` branch as well as Pidgin 3 on the `default` branch.
    +
    +The default branch has moved libgnt out to it's own repository at [bitbucket.org/pidgin/libgnt](https://bitbucket.org/pidgin/libgnt) to make it more accessible to other developers.
    +
    +Pidgin 3 also depends on [bitbucket.org/pidgin/talkatu](https://bitbucket.org/pidgin/talkatu) for reuseable [Gtk+](https://gtk.org) widgets that are geared towards messaging clients.
    +
    +Purple 3 has adopted [gplugin](https://bitbucket.org/gplugin/gplugin) which is a library that handles plugins in multiple langauages leveraging [gobject-introspection](https://gi.readthedocs.io/en/latest/). It currently supports, C/C++, Python, and Lua plugins.