Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
| 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
| 3 | <html> |
| 4 | <head> |
| 5 | <title>How To Release LLVM To The Public</title> |
| 6 | <link rel="stylesheet" href="llvm.css" type="text/css"> |
| 7 | </head> |
| 8 | <body> |
| 9 | |
| 10 | <div class="doc_title">How To Release LLVM To The Public</div> |
| 11 | <p class="doc_warning">NOTE: THIS DOCUMENT IS A WORK IN PROGRESS!</p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 12 | <ol> |
| 13 | <li><a href="#introduction">Introduction</a></li> |
Misha Brukman | 8ebd7f9 | 2006-04-10 21:43:05 +0000 | [diff] [blame] | 14 | <li><a href="#process">Release Process</a></li> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 15 | </ol> |
| 16 | <div class="doc_author"> |
| 17 | <p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p> |
| 18 | </div> |
| 19 | |
| 20 | <!-- *********************************************************************** --> |
| 21 | <div class="doc_section"><a name="introduction">Introduction</a></div> |
| 22 | <!-- *********************************************************************** --> |
| 23 | |
| 24 | <div class="doc_text"> |
| 25 | <p>This document collects information about successfully releasing LLVM to the |
| 26 | public. It is the release manager's guide to ensuring that a high quality build |
| 27 | of LLVM is released. Mostly, its just a bunch of reminders of things to do at |
| 28 | release time so we don't inadvertently ship something that is utility |
| 29 | deficient.</p> |
| 30 | </div> |
| 31 | |
| 32 | <!-- *********************************************************************** --> |
| 33 | <div class="doc_section"><a name="process">Release Process</a></div> |
| 34 | <!-- *********************************************************************** --> |
| 35 | |
| 36 | <!-- ======================================================================= --> |
| 37 | <div class="doc_subsection"><a name="overview">Process Overview</a></div> |
| 38 | <div class="doc_text"> |
| 39 | <ol> |
Misha Brukman | 8ebd7f9 | 2006-04-10 21:43:05 +0000 | [diff] [blame] | 40 | <li><a href="#merge">Merge Branches</a></li> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 41 | <li><a href="#settle">Settle LLVM HEAD</a></li> |
Misha Brukman | 8ebd7f9 | 2006-04-10 21:43:05 +0000 | [diff] [blame] | 42 | <li><a href="#build">Build LLVM</a></li> |
| 43 | <li><a href="#check">Run 'make check'</a></li> |
| 44 | <li><a href="#test">Run LLVM Test Suite</a></li> |
| 45 | <li><a href="#deps">make LibDeps.txt</a></li> |
| 46 | <li><a href="#tag">cvs tag</a></li> |
| 47 | <li><a href="#dist">make dist</a></li> |
| 48 | <li><a href="#release">release</a></li> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 49 | </ol> |
| 50 | </div> |
| 51 | |
| 52 | <!-- ======================================================================= --> |
| 53 | <div class="doc_subsection"><a name="merge">Merge Branches</a></div> |
| 54 | <div class="doc_text"> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 55 | <p>Merge any work done on branches intended for release into mainline. Work that |
| 56 | is not to be incorporated into the release should not be merged from the branch. |
| 57 | </p> |
| 58 | </div> |
| 59 | |
| 60 | <!-- ======================================================================= --> |
Reid Spencer | a5bbbce | 2006-04-11 06:22:15 +0000 | [diff] [blame^] | 61 | <div class="doc_subsection"><a name="settle">Settle CVS HEAD</a></div> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 62 | <div class="doc_text"> |
| 63 | <p>Use the nightly test reports, and 'make check' (deja-gnu based tests) to |
| 64 | increase the quality of LLVM and ensure that merged branches have not |
| 65 | destabilized LLVM.</p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 66 | </div> |
| 67 | |
| 68 | <!-- ======================================================================= --> |
| 69 | <div class="doc_subsection"><a name="build">Build LLVM</a></div> |
| 70 | <div class="doc_text"> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 71 | <p>Build both debug and release versions of LLVM on all platforms. Ensure |
| 72 | build is warning and error free on each platform.</p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 73 | </div> |
| 74 | |
| 75 | <!-- ======================================================================= --> |
| 76 | <div class="doc_subsection"><a name="check">Run 'make check'</a></div> |
| 77 | <div class="doc_text"> |
Misha Brukman | 8ebd7f9 | 2006-04-10 21:43:05 +0000 | [diff] [blame] | 78 | <p>Run <tt>make check</tt> and ensure there are no unexpected failures. If |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 79 | there are, resolve the failures and go back to <a href="#settle">step 2</a>. |
| 80 | Ensure that 'make check' passes on all platforms for all targets. If certain |
| 81 | failures cannot be resolved before release time, determine if marking them |
| 82 | XFAIL is appropriate. If not, fix the bug and go back. The test suite must |
| 83 | complete with "0 unexpected failures" for release. |
| 84 | </p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 85 | </div> |
| 86 | |
| 87 | <!-- ======================================================================= --> |
| 88 | <div class="doc_subsection"><a name="test">LLVM Test Suite</a></div> |
| 89 | <div class="doc_text"> |
| 90 | <p>Run the llvm-test suite and ensure there are no unacceptable failures. |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 91 | If there are, resolve the failures and go back to step 2. The test suite |
| 92 | should be run in Nightly Test mode. All tests must pass. If they do not, |
| 93 | investigate and go back to settling CVS HEAD.</p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 94 | </div> |
| 95 | |
| 96 | <!-- ======================================================================= --> |
| 97 | <div class="doc_subsection"><a name="deps">Make LibDeps.txt</a></div> |
| 98 | <div class="doc_text"> |
Misha Brukman | 8ebd7f9 | 2006-04-10 21:43:05 +0000 | [diff] [blame] | 99 | <p>Rebuild the <tt>LibDeps.txt</tt> target in <tt>utils/llvm-config</tt>. This |
| 100 | makes sure that the <tt>llvm-config</tt> utility remains relevant for the |
| 101 | release, reflecting any changes in the library dependencies.</p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 102 | </div> |
| 103 | |
| 104 | <!-- ======================================================================= --> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 105 | <div class="doc_subsection"><a name="tag">CVS Tag And Branch</a></div> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 106 | <div class="doc_text"> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 107 | <p>Tag and branch the CVS HEAD using the following procedure:</p> |
| 108 | <ol> |
| 109 | <li>Request all developers to refrain from committing. Offenders get commit |
| 110 | rights taken away (temporarily).</li> |
| 111 | <li>Tag the cvs HEAD with "ROOT_RELEASE_XX" where XX is the major and minor |
| 112 | release numbers (you can't have . in a cvs tag name). So, for Release 1.2, |
| 113 | XX=12 and for Release 1.10, XX=110.</li> |
| 114 | <li>Immediately create a cvs branch based on the ROOT_RELEASE tag. This is |
| 115 | where the release distribution will be created.</li> |
| 116 | <li>Advise developers they can work on CVS HEAD again.</li> |
| 117 | <li>Ensure all subsequent building and fixing is done on this branch.</li> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 118 | </div> |
| 119 | |
| 120 | <!-- ======================================================================= --> |
| 121 | <div class="doc_subsection"><a name="dist">Run 'make dist'</a></div> |
| 122 | <div class="doc_text"> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 123 | <p>Build the distribution, ensuring it is installable and working. This is a |
| 124 | two step process. First, use "make dist" to simply build the distribution. Any |
| 125 | failures need to be corrected (on the branch). Once "make dist" can be |
| 126 | successful, do "make dist-check". This target will do the same thing as the |
| 127 | 'dist' target but also test that distribution to make sure it works. This |
| 128 | ensures that needed files are not missing and that the src tarball can be |
| 129 | successfully unbacked, built, installed, and cleaned. This two-level testing |
| 130 | needs to be done on each target platform.</p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 131 | </div> |
| 132 | |
| 133 | <!-- ======================================================================= --> |
| 134 | <div class="doc_subsection"><a name="release">Release</a></div> |
| 135 | <div class="doc_text"> |
Reid Spencer | 1a2e110 | 2006-04-11 06:21:25 +0000 | [diff] [blame] | 136 | <p>Release the distribution tarball to the public. This consists of generating |
| 137 | several tarballs. The first set, the source distributions, are automatically |
| 138 | generated by the "make dist" and "make dist-check". There are gzip, bzip2, and |
| 139 | zip versions of these bundles.</p> |
| 140 | <p>The second set of tarballs is the binary release. When "make dist-check" |
| 141 | succeeds, it will have created an _install directory into which it installed |
| 142 | the binary release. You need to rename that directory as "llvm" and then |
| 143 | create tarballs from the contents of that "llvm" directory.</p> |
| 144 | <p>Finally, use rpm to make an rpm package based on the llvm.spec file. Don't |
| 145 | forget to update the version number, documentation, etc. in the llvm.spec |
| 146 | file.</p> |
Reid Spencer | cf427e8 | 2006-03-23 06:45:42 +0000 | [diff] [blame] | 147 | </div> |
| 148 | |
| 149 | <!-- *********************************************************************** --> |
| 150 | <hr> |
| 151 | <address> |
| 152 | <a href="http://jigsaw.w3.org/css-validator/check/referer"><img |
| 153 | src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a> |
| 154 | <a href="http://validator.w3.org/check/referer"><img |
| 155 | src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a> |
| 156 | |
| 157 | <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br> |
| 158 | <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a> |
| 159 | <br/> |
| 160 | Last modified: $Date$ |
| 161 | </address> |
| 162 | </body> |
| 163 | </html> |