doc/reference/libpurple/mercurial.md

Thu, 21 Jul 2022 01:10:22 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Thu, 21 Jul 2022 01:10:22 -0500
changeset 41454
7cc69bde919d
parent 41164
d861b10105fb
permissions
-rw-r--r--

Update pidgin for the purple_account_manager_get_(in)active deprecations

Testing Done:
Compiled and made sure the menus still functioned as expected.

Reviewed at https://reviews.imfreedom.org/r/1536/

41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
1 Title: Using Pidgin Mercurial
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
2 Slug: using-pidgin-mercurial
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
3
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
4 ## Using Pidgin Mercurial
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
6 ### Introduction
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
7
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
8 These instructions will help you clone a copy of any of the Pidgin
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
9 related [Mercurial](https://mercurial-scm.org)
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
10 repositories and keep them up to date.
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
11
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
12 These instructions are just for cloning/updating the Pidgin repositories.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
13 If you're looking for documentation on contributing code, please see the
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
14 [Code Contributions](code_contributions.html)
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
15 page after you have successfully cloned the repository from this page.
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
16
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
17 ### Cloning
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
18
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
19 In Distributed Version Control, ***cloning*** is the act
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
20 of acquiring a source repository. All of the Pidgin repositories are
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
21 hosted in Mercurial at
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
22 [keep.imfreedom.org](https://keep.imfreedom.org/). To
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
23 clone them you will be using the command
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
24 `hg clone <URL>`. The specific URL can be looked up in
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
25 the table below depending what you are trying to clone.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
26
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
27 > If you are trying to build Pidgin 3, you can just clone that repository and
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
28 > the build system will automatically clone the other repositories for you.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
29
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
30 #### Repositories
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
31
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
32 [https://keep.imfreedom.org/gplugin/gplugin/](https://keep.imfreedom.org/gplugin/gplugin/)
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
33 : The plugin library used in Pidgin 3.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
34
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
35 [https://keep.imfreedom.org/libgnt/libgnt/](https://keep.imfreedom.org/libgnt/libgnt/)
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
36 : The toolkit library used in Finch.
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
37
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
38 [https://keep.imfreedom.org/pidgin/pidgin/](https://keep.imfreedom.org/pidgin/pidgin/)
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
39 : The main Pidgin repository that contains LibPurple, Pidgin, and Finch.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
40
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
41 [https://keep.imfreedom.org/talkatu/talkatu/](https://keep.imfreedom.org/talkatu/talkatu/)
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
42 : The conversation widgets used in Pidgin 3.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
43
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
44 You can see an example clone of Talkatu below but all of the repositories will
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
45 output a similar result.
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
46
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
47 ```sh
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
48 $ hg clone https://keep.imfreedom.org/talkatu/talkatu
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
49 destination directory: talkatu
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
50 requesting all changes
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
51 adding changesets
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
52 adding manifests
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
53 adding file changes
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
54 added 348 changesets with 1074 changes to 268 files
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
55 new changesets 0feed1461a4a:f0fda4aace2d
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
56 updating to branch default
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
57 109 files updated, 0 files merged, 0 files removed, 0 files unresolved
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
58 ```
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
59
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
60 ### Keeping Your Clone Up To Date
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
61
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
62 If you are just tracking Pidgin development and are not contributing, chances
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
63 are you are still on the ***default*** branch. But let's make sure, and run
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
64 `hg update default`. This will change to the ***default*** branch if you're
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
65 not currently on it or do nothing.
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
66
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
67 Now that you are on the ***default*** branch, you can
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
68 simply run `hg pull --update` to pull in all new changes and
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
69 update your local copy. Please note, if you accidentally run
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
70 `hg pull`, that is without the update, a subsequent
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
71 `hg pull --update` will not update to the latest revisions as
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
72 this invocation of `hg pull` did not find any new revisions. To
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
73 properly update in this scenario, you'll need to run
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
74 `hg update`.
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
75
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
76 Below is an example of updating Talkatu when it's already up to date.
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
77
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
78 ```sh
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
79 $ hg pull --update
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
80 pulling from https://keep.imfreedom.org/talkatu/talkatu
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
81 searching for changes
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
82 no changes found
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
83 ```
40716
7a4e48594a24 Update all of the development documentation
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
84
41164
d861b10105fb Convert the libpurple docs to gi-docgen
Gary Kramlich <grim@reaperworld.com>
parents: 40716
diff changeset
85 At this point you can review the code, build it, patch it, etc.

mercurial