kde-dev-scripts/doc/man-fixincludes.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 <author><personname><firstname>Ben</firstname><surname>Burton</surname></personname>
0009 <email>bab@debian.org</email></author>
0010 <date>2003-04-07</date>
0011 </refentryinfo>
0012
0013 <refmeta>
0014 <refentrytitle><command>fixincludes</command></refentrytitle>
0015 <manvolnum>1</manvolnum>
0016 </refmeta>
0017
0018 <refnamediv>
0019 <refname><command>fixincludes</command></refname>
0020 <refpurpose>Reduce the number of #includes in &kde; source files</refpurpose>
0021 </refnamediv>
0022
0023 <refsynopsisdiv>
0024 <cmdsynopsis>
0025 <command>fixincludes</command>
0026 <group><option>-v, --verbose</option></group>
0027 <group><option>-e, --experimental</option></group>
0028 <group><option>-m, --modify</option></group>
0029 <group><option><replaceable>file</replaceable></option></group>
0030 <group><option>--help</option></group>
0031 </cmdsynopsis>
0032 </refsynopsisdiv>
0033
0034 <refsect1>
0035 <title>Description</title>
0036
0037 <para><command>fixincludes</command> tries to reduce the number of
0038 #includes in C++ source files.  Much of it's processing is specific to
0039 &kde; sources and so it might not work so well with sources for
0040 non-&kde; applications.</para>
0041
0042 <para>The following problems are identified by <command>fixincludes</command>:</para>
0043
0044 <itemizedlist>
0045 <listitem>
0046 <para>Including headers that are no longer supported but which exist for compatibility with older Qt/KDE versions;</para>
0047 </listitem>
0048 <listitem>
0049 <para>Including the same file multiple times. </para>
0050 </listitem>
0051 </itemizedlist>
0052
0053 <para>There is also an experimental mode which tries removing each
0054 #include one at a time (with a few exceptions) to see whether the
0055 source still compiles. Note that this experimental mode will modify
0056 the original sources. </para>
0057
0058 <para>By default the sources will not be modified; the identified
0059 problems will simply be written to standard output. </para>
0060
0061 <para>The list of C++ sources to examine should be given on the
0062 command-line. If no files are given, all C++ sources in or beneath the
0063 current directory will be examined (with the exception of directories
0064 whose <filename>Makefile.am</filename> contains
0065 <option>-UQT_NO_COMPAT</option> or
0066 <option>-UKDE_NO_COMPAT</option>)</para>
0067
0068 <para>This utility is part of the KDE Software Development Kit. </para>
0069
0070 </refsect1>
0071
0072 <refsect1>
0073 <title>Options</title>
0074
0075 <variablelist>
0076 <varlistentry>
0077 <term><option>-v, --verbose</option></term>
0078 <listitem><para>Verbose mode.  Additional debugging output is written to standard output.</para></listitem>
0079 </varlistentry>
0080 <varlistentry>
0081 <term><option>-e, --experimental</option></term>
0082 <listitem><para>Experimental mode, as described above in detail. Note that this option implies <option>--modify</option>.</para></listitem>
0083 </varlistentry>
0084 <varlistentry>
0085 <term><option>-m, --modify</option></term>
0086 <listitem><para>As well as writing messages to standard output, actually modify the original sources to fix any problems that were found.</para></listitem>
0087 </varlistentry>
0088 </variablelist>
0089
0090 </refsect1>
0091
0092 <refsect1>
0093 <title>Authors</title>
0094 <para><command>fixincludes</command> was written by Dirk Mueller <email>mueller@kde.org</email>.
0095 </para>
0096 </refsect1>
0097
0098 </refentry>