1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
## SCM
- anonymous checkouts
```console
git clone git://git.freedesktop.org/git/upower.git
```
- checkouts if you got an ssh account on fd.o (username@ is optional)
```console
git clone ssh://[username@]git.freedesktop.org/git/upower.git
```
- commit to local repository
```console
git commit -a
```
- push local repository to master repository at fd.o (remember most patches
requires review at the mailing list)
```console
git push
```
- pull changes from master repository at fd.o
```console
git pull
```
- diff of working tree versus local repository
```console
git diff
```
- diff of local repository vs. master repository at fd.o
- synchronize with upstream repo:
```console
git pull #(possibly merge changes)
```
- generate the diff:
```console
git diff origin HEAD
```
- influential environment variables (set these in e.g. .bash_profile)
```bash
export GIT_AUTHOR_NAME='Your Full Name'
export GIT_COMMITTER_NAME='Your Full Name'
export GIT_COMMITTER_EMAIL=<youremail@domain.net>
export GIT_AUTHOR_EMAIL=<youremail@domain.net>
```
- see also
<http://www.kernel.org/pub/software/scm/git/docs/>
## Set up Git environment
Run the following command to include the upower Git configurations.
```bash
cd contrib
./setup
```
## Committing code
- Commit messages should be of the form (the five lines between the
lines starting with ===)
```text
=== begin example commit ===
short explanation of the commit
Longer explanation explaining exactly what's changed, whether any
external or private interfaces changed, what bugs were fixed (with bug
tracker reference if applicable) and so forth. Be concise but not too brief.
=== end example commit ===
```
- Always add a brief description of the commit to the _first_ line of
the commit and terminate by two newlines (it will work without the
second newline, but that is not nice for the interfaces).
- First line (the brief description) must only be one sentence and
must not start with a capital letter. Don't use a trailing period
either.
- The main description (the body) is normal prose and should use normal
punctuation and capital letters where appropriate. Normally, for patches
sent to a mailing list it's copied from there.
- When committing code on behalf of others use the `--author` option, e.g.
```console
git commit -a --author "Joe Coder <joe@coder.org>"
```
## Coding Style
- Please follow the coding style already used.
- Write docs for all functions and structs and so on. We use gtkdoc format.
- All external interfaces (network protocols, file formats, etc.)
should have documented specifications sufficient to allow an
alternative implementation to be written. Our implementation should
be strict about specification compliance (should not for example
heuristically parse a file and accept not-well-formed
data). Avoiding heuristics is also important for security reasons;
if it looks funny, ignore it (or exit, or disconnect).
## Testing
Under Linux, with the umockdev package installed, you can run
```console
ninja test
```
in the root build directory to run an automated test suite.
|
