Difference between revisions of "Recommended global variables"
From Code::Blocks
m |
|||
| Line 5: | Line 5: | ||
If you call the location of your wxWidgets installation <tt>#wx</tt>, and two other developers call them <tt>#wxwin</tt> and <tt>#wxwidgets</tt> in their projects, then somebody compiling all three projects will be promted three times for the same thing. This is obviously less than optimal. | If you call the location of your wxWidgets installation <tt>#wx</tt>, and two other developers call them <tt>#wxwin</tt> and <tt>#wxwidgets</tt> in their projects, then somebody compiling all three projects will be promted three times for the same thing. This is obviously less than optimal. | ||
| − | This list is provided as a guideline and in no way | + | This list is provided as a guideline and in no way authoritative. However, if you use the names in this list, chances are good that people trying to compile your projects will be a lot happier. |
| Line 11: | Line 11: | ||
<caption>List of "well known" names for [[global user variables]]</caption> | <caption>List of "well known" names for [[global user variables]]</caption> | ||
<tr><th colspan=2>IDE and compilers</th></tr> | <tr><th colspan=2>IDE and compilers</th></tr> | ||
| − | <tr><td width=72 align=center>cb</td><td>Location of the <i>development</i> version of Code::Blocks | + | <tr><td width=72 align=center>cb</td><td>Location of the <i>development</i> version of Code::Blocks. If you have the sources, this is the dir with the Code::Blocks project file or, if you have the Code::Blocks SDK, this is the dir where you unpacked it.</td></tr> |
<tr><td width=72 align=center>gcc</td><td>Base directory of your gcc or MinGW installation</td></tr> | <tr><td width=72 align=center>gcc</td><td>Base directory of your gcc or MinGW installation</td></tr> | ||
<tr><td width=72 align=center>msvc</td><td>Base directory of your MSVC toolkit installation</td></tr> | <tr><td width=72 align=center>msvc</td><td>Base directory of your MSVC toolkit installation</td></tr> | ||
| − | <tr><td width=72 align=center> | + | <tr><td width=72 align=center>psdk</td><td>Location of the Microsoft platform SDK (base dir)</td></tr> |
<tr><td width=72 align=center>dm</td><td>Base directory of your Digital Mars installation</td></tr> | <tr><td width=72 align=center>dm</td><td>Base directory of your Digital Mars installation</td></tr> | ||
<tr><th colspan=2>GUI toolkits</th></tr> | <tr><th colspan=2>GUI toolkits</th></tr> | ||
| Line 27: | Line 27: | ||
<tr><td width=72 align=center>genesis</td><td>Base directory of Genesis 3D</td></tr> | <tr><td width=72 align=center>genesis</td><td>Base directory of Genesis 3D</td></tr> | ||
<tr><td width=72 align=center>cs</td><td>Base directory of Crystal Space</td></tr> | <tr><td width=72 align=center>cs</td><td>Base directory of Crystal Space</td></tr> | ||
| − | <tr><td width=72 align=center> | + | <tr><td width=72 align=center>irr</td><td>Base directory of Irrlicht</td></tr> |
<tr><th colspan=2>Other packages</th></tr> | <tr><th colspan=2>Other packages</th></tr> | ||
<tr><td width=72 align=center>openal</td><td>Base directory of OpenAL</td></tr> | <tr><td width=72 align=center>openal</td><td>Base directory of OpenAL</td></tr> | ||
<tr><td width=72 align=center>zlib</td><td>Base directory of zlib</td></tr> | <tr><td width=72 align=center>zlib</td><td>Base directory of zlib</td></tr> | ||
</table> | </table> | ||
Revision as of 21:05, 12 November 2005
Technically, it does not matter how you name your global user variables. However, if you wish to maximise the benefit of using global user variables, then you better make sure that the same name always means the same thing!
Example:
If you call the location of your wxWidgets installation #wx, and two other developers call them #wxwin and #wxwidgets in their projects, then somebody compiling all three projects will be promted three times for the same thing. This is obviously less than optimal.
This list is provided as a guideline and in no way authoritative. However, if you use the names in this list, chances are good that people trying to compile your projects will be a lot happier.
| IDE and compilers | |
|---|---|
| cb | Location of the development version of Code::Blocks. If you have the sources, this is the dir with the Code::Blocks project file or, if you have the Code::Blocks SDK, this is the dir where you unpacked it. |
| gcc | Base directory of your gcc or MinGW installation |
| msvc | Base directory of your MSVC toolkit installation |
| psdk | Location of the Microsoft platform SDK (base dir) |
| dm | Base directory of your Digital Mars installation |
| GUI toolkits | |
| wx | Base directory of wxWidgets |
| fl | Base directory of FLTK |
| qt | Base directory of Qt |
| Graphics toolkits | |
| sdl | Base directory of SDL |
| ft | Base directory of freetype |
| ogre | Base directory of Ogre 3D |
| g3d | Base directory of Graphics 3D |
| genesis | Base directory of Genesis 3D |
| cs | Base directory of Crystal Space |
| irr | Base directory of Irrlicht |
| Other packages | |
| openal | Base directory of OpenAL |
| zlib | Base directory of zlib |
