Note about DFBSD_MAJOR in gcc 4.1
[ikiwiki.git] / docs / developer / Release / index.mdwn
CommitLineData
86b77dc1 1#The art of releasing
2
3This is a template on how to do a release.
4
ad252dc8 5##Branching
6
7On crater branch the repo:
8
9 cd /repository/git/dragonfly.git
10 git branch DragonFly_RELEASE_x_y (e.g. 2_8)
11
3691609e 12This is the only step that needs to happen remotely.
13
14On your own system:
15
ad252dc8 16Check out two copies of /usr/src, one with master checked out, one with the new release branch checked out. Checkouts should be under your user id, NOT as root, or the later tagging operation will be unhappy.
17
18On the new branch:
19
20 vi sys/sys/param.h
21
22Edit \__DragonFly\_version and related comments. Be sure to add a comment for the new master too (but the version is set to the new release).
23
24 vi sys/conf/newvers.sh
25
26Edit BRANCH, use 'RELEASE', update version. e.g. RELEASE_2_8
27
28On master
29
30 vi sys/sys/param.h
31
32Edit \__DragonFly\_version and related comments.
33
34 vi sys/conf/newvers.sh
35
36Edit BRANCH, use 'DEVELOPMENT', update version.
37
38##Tagging
39
40Make sure all changes on the master branch and on the new branch have been committed and pushed before tagging anything.
41
42man git-tag for info, the committer needs GPG set up so git tag -s works. Then you can use your own checkout. Be sure the checkouts are under your user id and you do the tagging as yourself instead of as root.
43
44###In master
45
46 git tag -s -m "DragonFly 2.x.x" v2.x.x
47 git push --tags
48
49###In the new branch
50
51 git tag -s -m "DragonFly 2.x.x" v2.x.x
52 git push --tags
53
54Do the x.x.0 immediately. Just before doing the final nrelease build roll a x.x.1 tag for the release branch. Release as x.x.1.
55
930c5043 56## Subsequent tag updates
57
58When updating a x.x.1 version, you just need to edit sys/sys/param.h in the appropriate branch and then tag.
59
bdb68a03 60## Something in GCC
61
62The file gnu/usr.bin/cc41/cc_prep/config/dragonfly.h has a spot where the major version number for DragonFly is encoded. I don't know if this applies for anything other than gcc 4.1.
63
64 #define DFBSD_MAJOR 3
65
ad252dc8 66##Pkgsrc
67
68Adjust bulk builds to the release's pkgsrc branch, and make sure they upload to the right directories on avalon.dragonflybsd.org.
69
70Adjust the default pkgsrc checkout in /usr/src/etc/Makefile.usr for both master and the new branch if necessary.
86b77dc1 71
86b77dc1 72###build isos and imgs
73
d513516b 74
75
86b77dc1 76###build pkgsrc packages
77
78###testing
79
80i386 iso, img, gui-img
81x86_64 iso, img, gui-img
82
83
84booting install media
85
86installing, encrypted, unencrypted, ufs, hammer
87
88configuring in the installer
89
90booting installed system
91
92testing on real hardware, qemu, vmware
93
d513516b 94###Release Notes
95
96Copy one of the existing release pages. The general format is :
97
98* General announcement
99* Big items new to this release
100* Availability, describing what can be run
101* MD5 results for compressed and uncompressed files
102* Special notes and caveats
103* Release notes - go through git log for these.
104
105###File Copy
86b77dc1 106
d513516b 107Place images in /ftp/iso-images on crater.dragonflybsd.org. They will be rsynced to mirror-master.
86b77dc1 108
109###announce
110users@, web page