kde-dev-scripts/doc/man-cheatmake.1.docbook

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003 <!ENTITY % English "INCLUDE">
0004 ]>
0005
0006 <refentry lang="&language;">
0007 <refentryinfo>
0008 <date>2003-03-08</date>
0009 </refentryinfo>
0010
0011 <refmeta>
0012 <refentrytitle><command>cheatmake</command></refentrytitle>
0013 <manvolnum>1</manvolnum>
0014 </refmeta>
0015
0016 <refnamediv>
0017 <refname><command>cheatmake</command></refname>
0018 <refpurpose>fool <command>make</command> into not rebuilding certain files</refpurpose>
0019 </refnamediv>
0020
0021 <refsynopsisdiv>
0022 <cmdsynopsis>
0023 <command>cheatmake</command>
0024
0025 <group><option>hidechange</option> <replaceable>file</replaceable></group>
0026 <group><option>show</option></group>
0027 <group><option>why</option> <replaceable>file</replaceable></group>
0028 </cmdsynopsis>
0029 </refsynopsisdiv>
0030
0031 <refsect1>
0032 <title>Description</title>
0033
0034 <para><command>cheatmake</command> is used to save time when
0035 recompiling. It can fool make into skipping files that haven't changed
0036 in a meaningful way. This can be used for instance when you change a
0037 comment in a file but none of the actual code.</para>
0038
0039 <para>This utility is part of the &kde; Software Development Kit. </para>
0040
0041 </refsect1>
0042
0043 <refsect1>
0044 <title>Options</title>
0045
0046 <variablelist>
0047 <varlistentry>
0048 <term><option>hidechange</option> <replaceable>file</replaceable></term>
0049 <listitem><para>Hides the fact that file was changed by setting the timestamp into the past.  Use with care!</para>
0050 </listitem>
0051 </varlistentry>
0052 <varlistentry>
0053 <term><option>show</option></term>
0054 <listitem><para>Lists what files <command>make</command> currently needs to rebuild</para></listitem>
0055 </varlistentry>
0056 <varlistentry>
0057 <term><option>why</option> <replaceable>file</replaceable></term>
0058 <listitem><para>Explains why make must rebuild file</para></listitem>
0059 </varlistentry>
0060 </variablelist>
0061 </refsect1>
0062
0063 <refsect1>
0064 <title>Environment</title>
0065
0066 <para>One of the following variables (but not both) should be set if
0067 the source directory is different from the build directory. If the
0068 build directory is simply a subdirectory of the source directory, the
0069 simpler variable <envar>OBJ_SUBDIR</envar> should be used. </para>
0070
0071 <variablelist>
0072 <varlistentry>
0073 <term><envar>OBJ_SUBJDIR</envar></term>
0074 <listitem><para>Indicates that the build directory is in the given subdirectory of the source directory. For instance, if the source directory is <filename class="directory">kdesdk</filename> and the build directory is <filename class="directory">kdesdk/obj-i386-linux</filename>, then <envar>OBJ_SUBDIR</envar> should be set to <parameter>obj-i386-linux</parameter>.</para></listitem>
0075 </varlistentry>
0076 <varlistentry>
0077 <term><envar>OBJ_REPLACEMENT</envar></term>
0078 <listitem><para>A <command>sed</command> expression that is used to transform the source directory into the build directory.  For instance, if the source directory is <filename class="directory">kdesdk/obj-i386-linux</filename>, then <envar>OBJ_REPLACEMENT</envar> should be set to <parameter>s#kdesdk#kdesdk-obj#</parameter>.</para>
0079 </listitem>
0080 </varlistentry>
0081 </variablelist>
0082
0083 </refsect1>
0084
0085 <refsect1>
0086 <title>See Also</title>
0087
0088 <para>make(1)</para>
0089
0090 </refsect1>
0091
0092 <refsect1>
0093 <title>Authors</title>
0094
0095 <para><command>cheatmake</command> was written by &David.Faure; &David.Faure.mail;.  This manual page was
0096 prepared by <personname><firstname>Ben</firstname><surname>Burton</surname></personname>
0097 <email>bab@debian.org</email> for the Debian
0098 <acronym>GNU</acronym>/&Linux; system (but may be used by
0099 others).</para>
0100
0101 </refsect1>
0102
0103 </refentry>