| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <link rel="STYLESHEET" href="dist.css" type='text/css' /> |
| 5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> |
| 6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> |
| 7 | <link rel="first" href="dist.html" title='Distributing Python Modules' /> |
| 8 | <link rel='index' href='genindex.html' title='Index' /> |
| 9 | <link rel='last' href='about.html' title='About this document...' /> |
| 10 | <link rel='help' href='about.html' title='About this document...' /> |
| 11 | <link rel="prev" href="manifest.html" /> |
| 12 | <link rel="parent" href="source-dist.html" /> |
| 13 | <link rel="next" href="built-dist.html" /> |
| 14 | <meta name='aesop' content='information' /> |
| 15 | <title>4.2 Manifest-related options</title> |
| 16 | </head> |
| 17 | <body> |
| 18 | <DIV CLASS="navigation"> |
| 19 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> |
| 20 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 21 | <tr> |
| 22 | <td class='online-navigation'><a rel="prev" title="4.1 Specifying the files" |
| 23 | href="manifest.html"><img src='../icons/previous.png' |
| 24 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 25 | <td class='online-navigation'><a rel="parent" title="4. Creating a Source" |
| 26 | href="source-dist.html"><img src='../icons/up.png' |
| 27 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 28 | <td class='online-navigation'><a rel="next" title="5. Creating Built Distributions" |
| 29 | href="built-dist.html"><img src='../icons/next.png' |
| 30 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 31 | <td align="center" width="100%">Distributing Python Modules</td> |
| 32 | <td class='online-navigation'><img src='../icons/blank.png' |
| 33 | border='0' height='32' alt='' width='32' /></td> |
| 34 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' |
| 35 | border='0' height='32' alt='Module Index' width='32' /></a></td> |
| 36 | <td class='online-navigation'><a rel="index" title="Index" |
| 37 | href="genindex.html"><img src='../icons/index.png' |
| 38 | border='0' height='32' alt='Index' width='32' /></A></td> |
| 39 | </tr></table> |
| 40 | <div class='online-navigation'> |
| 41 | <b class="navlabel">Previous:</b> |
| 42 | <a class="sectref" rel="prev" href="manifest.html">4.1 Specifying the files</A> |
| 43 | <b class="navlabel">Up:</b> |
| 44 | <a class="sectref" rel="parent" href="source-dist.html">4. Creating a Source</A> |
| 45 | <b class="navlabel">Next:</b> |
| 46 | <a class="sectref" rel="next" href="built-dist.html">5. Creating Built Distributions</A> |
| 47 | </div> |
| 48 | <hr /></div> |
| 49 | </DIV> |
| 50 | <!--End of Navigation Panel--> |
| 51 | |
| 52 | <H1><A NAME="SECTION004200000000000000000"></A> |
| 53 | <A NAME="manifest-options"></A> |
| 54 | <BR> |
| 55 | 4.2 Manifest-related options |
| 56 | </H1> |
| 57 | |
| 58 | <P> |
| 59 | The normal course of operations for the <code class="du-command">sdist</code> command is as |
| 60 | follows: |
| 61 | |
| 62 | <UL> |
| 63 | <LI>if the manifest file, <span class="file">MANIFEST</span> doesn't exist, read |
| 64 | <span class="file">MANIFEST.in</span> and create the manifest |
| 65 | </LI> |
| 66 | <LI>if neither <span class="file">MANIFEST</span> nor <span class="file">MANIFEST.in</span> exist, create a |
| 67 | manifest with just the default file set |
| 68 | </LI> |
| 69 | <LI>if either <span class="file">MANIFEST.in</span> or the setup script (<span class="file">setup.py</span>) |
| 70 | are more recent than <span class="file">MANIFEST</span>, recreate <span class="file">MANIFEST</span> by |
| 71 | reading <span class="file">MANIFEST.in</span> |
| 72 | </LI> |
| 73 | <LI>use the list of files now in <span class="file">MANIFEST</span> (either just |
| 74 | generated or read in) to create the source distribution archive(s) |
| 75 | </LI> |
| 76 | </UL> |
| 77 | There are a couple of options that modify this behaviour. First, use |
| 78 | the <b class="programopt">--no-defaults</b> and <b class="programopt">--no-prune</b> to |
| 79 | disable the standard ``include'' and ``exclude'' sets. |
| 80 | |
| 81 | <P> |
| 82 | Second, you might want to force the manifest to be regenerated--for |
| 83 | example, if you have added or removed files or directories that match an |
| 84 | existing pattern in the manifest template, you should regenerate the |
| 85 | manifest: |
| 86 | |
| 87 | <P> |
| 88 | <div class="verbatim"><pre> |
| 89 | python setup.py sdist --force-manifest |
| 90 | </pre></div> |
| 91 | |
| 92 | <P> |
| 93 | Or, you might just want to (re)generate the manifest, but not create a |
| 94 | source distribution: |
| 95 | |
| 96 | <P> |
| 97 | <div class="verbatim"><pre> |
| 98 | python setup.py sdist --manifest-only |
| 99 | </pre></div> |
| 100 | |
| 101 | <P> |
| 102 | <b class="programopt">--manifest-only</b> implies <b class="programopt">--force-manifest</b>. |
| 103 | <b class="programopt">-o</b> is a shortcut for <b class="programopt">--manifest-only</b>, and |
| 104 | <b class="programopt">-f</b> for <b class="programopt">--force-manifest</b>. |
| 105 | |
| 106 | <P> |
| 107 | |
| 108 | <DIV CLASS="navigation"> |
| 109 | <div class='online-navigation'> |
| 110 | <p></p><hr /> |
| 111 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 112 | <tr> |
| 113 | <td class='online-navigation'><a rel="prev" title="4.1 Specifying the files" |
| 114 | href="manifest.html"><img src='../icons/previous.png' |
| 115 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 116 | <td class='online-navigation'><a rel="parent" title="4. Creating a Source" |
| 117 | href="source-dist.html"><img src='../icons/up.png' |
| 118 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 119 | <td class='online-navigation'><a rel="next" title="5. Creating Built Distributions" |
| 120 | href="built-dist.html"><img src='../icons/next.png' |
| 121 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 122 | <td align="center" width="100%">Distributing Python Modules</td> |
| 123 | <td class='online-navigation'><img src='../icons/blank.png' |
| 124 | border='0' height='32' alt='' width='32' /></td> |
| 125 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' |
| 126 | border='0' height='32' alt='Module Index' width='32' /></a></td> |
| 127 | <td class='online-navigation'><a rel="index" title="Index" |
| 128 | href="genindex.html"><img src='../icons/index.png' |
| 129 | border='0' height='32' alt='Index' width='32' /></A></td> |
| 130 | </tr></table> |
| 131 | <div class='online-navigation'> |
| 132 | <b class="navlabel">Previous:</b> |
| 133 | <a class="sectref" rel="prev" href="manifest.html">4.1 Specifying the files</A> |
| 134 | <b class="navlabel">Up:</b> |
| 135 | <a class="sectref" rel="parent" href="source-dist.html">4. Creating a Source</A> |
| 136 | <b class="navlabel">Next:</b> |
| 137 | <a class="sectref" rel="next" href="built-dist.html">5. Creating Built Distributions</A> |
| 138 | </div> |
| 139 | </div> |
| 140 | <hr /> |
| 141 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> |
| 142 | </DIV> |
| 143 | <!--End of Navigation Panel--> |
| 144 | <ADDRESS> |
| 145 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. |
| 146 | </ADDRESS> |
| 147 | </BODY> |
| 148 | </HTML> |