Skip to content

Commit faa046f

Browse files
committed
documentation updates
1 parent f6b2573 commit faa046f

File tree

2 files changed

+43
-18
lines changed

2 files changed

+43
-18
lines changed

doc/sync-upstream-joyent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
## Check out the upstream\_joyent branch
55

6-
NOTE: make sure you did all the steps in _sync-upstream.md_ before!
6+
NOTE: make sure you have done all of the steps in _sync-upstream.md_ before
7+
proceeding!
78

89
```shell
910
$ git checkout upstream_joyent
@@ -42,8 +43,7 @@ _joyent-merge/YYYYMMDDnn_ where _nn_ starts at 01 and is incremented in
4243
the case that there is more than one merge in the same day.
4344

4445
```shell
45-
$ git checkout master
46-
$ git checkout -b joyent-merge/2017070501
46+
$ git checkout -b joyent-merge/2017070501 master
4747
Switched to a new branch 'joyent-merge/2017070501'
4848
```
4949

doc/sync-upstream.md

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
Fork the _omniosorg/illumos-omnios_ repository to your personal GitHub profile.
77
Then clone it to your development machine.
88

9-
```shell
9+
```
1010
$ git clone git@github.com:<github_name>/illumos-omnios.git
1111
```
1212

1313
Set-up remote repositories.
1414

15-
```shell
15+
```
1616
$ git remote add upstream git@github.com:omniosorg/illumos-omnios.git
1717
$ git remote add -t master upstream_gate https://github.com/illumos/illumos-gate.git
1818
$ git remote add -t master upstream_joyent https://github.com/joyent/illumos-joyent.git
@@ -31,7 +31,7 @@ upstream_joyent https://github.com/joyent/illumos-joyent.git (push)
3131

3232
Update your local repository.
3333

34-
```shell
34+
```
3535
$ git checkout master
3636
$ git pull upstream master
3737
@@ -47,22 +47,27 @@ result in a clean working tree.
4747

4848
Push the upstream branches to the remote repositories.
4949

50-
```shell
51-
$ git push -u upstream upstream_gate
52-
$ git push -u upstream upstream_joyent
53-
50+
```
5451
$ git push -u origin upstream_gate
5552
$ git push -u origin upstream_joyent
5653
```
5754

55+
Optionally, if you have write access to the `omniosorg/illumos-omnios`
56+
repository, put the upstream branches to there too:
57+
58+
```
59+
$ git push -u upstream upstream_gate
60+
$ git push -u upstream upstream_joyent
61+
```
62+
5863
## Merge upstream changes into new branch
5964

6065
Create a new branch into which the upstream changes will be merged in order
6166
to create a pull request. The branch name should be
6267
_upstream-merge/YYYYMMDDnn_ where _nn_ starts at 01 and is incremented in
6368
the case that there is more than one merge in the same day.
6469

65-
```shell
70+
```
6671
$ git checkout -b upstream-merge/2017070301 master
6772
```
6873

@@ -73,7 +78,7 @@ accompanying infrastructure.
7378

7479
### Process for a successful merge
7580

76-
```shell
81+
```
7782
$ git merge upstream_gate
7883
7984
$ git status
@@ -83,7 +88,7 @@ nothing to commit, working tree clean
8388

8489
### Process for a failed merge
8590

86-
```shell
91+
```
8792
$ git merge upstream_gate
8893
Auto-merging usr/src/uts/intel/sys/ucontext.h
8994
... additional output deleted ...
@@ -100,24 +105,34 @@ Unmerged paths:
100105
Once you have manually resolved the conflicts, add the files and commit
101106
the change.
102107

103-
```shell
108+
```
104109
$ git add usr/src/head/lastlog.h
105110
$ git add usr/src/man/man1m/zonecfg.1m
106111
$ git commit
107112
```
108113

109114
## Perform a test build
110115

111-
```shell
116+
```
112117
$ nightly /path/to/omnios.env
113118
```
114119

115120
If the build is unsuccessful, resolve this before moving on to the next
116121
step.
117122

123+
## ONU to the new build
124+
125+
```
126+
# onu -t 20170703 -d */path/to/illumos-omnios/packages/i386/nightly-nd
127+
...
128+
# init 6
129+
```
130+
131+
Confirm that the system boots.
132+
118133
## Push the merged branch
119134

120-
```shell
135+
```
121136
$ git push -u origin upstream-merge/2017070301
122137
Counting objects: 1224, done.
123138
Delta compression using up to 40 threads.
@@ -141,5 +156,15 @@ are backport candidates in the description of the PR. If there are none
141156
state that too;
142157
* Assign reviewers and the _upstream-merge_ tag.
143158

144-
As soon as your PR has been merged, head over to
145-
[_sync-upstream-joyent.md_.](sync-upstream-joyent.md)
159+
## Update master branch
160+
161+
As soon as your PR has been merged, update your master branch:
162+
163+
```
164+
$ git checkout master
165+
$ git pull upstream master
166+
$ git push
167+
```
168+
169+
and head over to [_sync-upstream-joyent.md_.](sync-upstream-joyent.md)
170+

0 commit comments

Comments
 (0)