File: em_make.1.xml

package info (click to toggle)
emdebian-tools 1.4.3
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 1,112 kB
  • ctags: 274
  • sloc: perl: 6,297; xml: 4,828; sh: 1,902; php: 406; ansic: 189; makefile: 15
file content (162 lines) | stat: -rw-r--r-- 6,162 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="em_make">
  <refentryinfo>
    <productname>em_make</productname>
    <productnumber/>
  </refentryinfo>
  <refmeta>
    <refentrytitle>em_make</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="source">EMDEBIAN-TOOLS</refmiscinfo>
    <refmiscinfo class="manual">EMDEBIAN-TOOLS</refmiscinfo>
  </refmeta>
  <refnamediv id="name">
    <refname>em_make</refname>
    <refpurpose>em_make is the emdebian version of dh_make.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>em_make</command>
      <group>
        <arg>-a</arg>
        <arg>--arch</arg>
        <replaceable> ARCH</replaceable>
      </group>
      <group>
        <arg>-v</arg>
        <arg>--verbose</arg>
      </group>
      <group>
        <arg>-q</arg>
        <arg>--quiet</arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>em_make</command>
      <group>
        <arg>-h</arg>
        <arg>--help</arg>
      </group>
      <group>
        <arg>--version</arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para><filename>em_make</filename> is an emdebian equivalent for
        <filename>dh_make</filename> and uses some of the same code.</para>
    <para><filename>em_make</filename> only does so much - many packages will
        require manual editing of debian/rules or other files to make a usable
        emdebian package.</para>
    <para><filename>em_make</filename> calculates an emdebian versionstring for
        an initial emdebian release and inserts an entry into debian/changelog.
        <filename>em_make</filename> parses debian/control (or debian/control.in if
        it exists), truncates all debian/*.doc-base.* files and removes all package
        descriptions that end in -doc from debian/control.</para>
    <note>
      <title>only run em_make once</title>
      <para><command>em_make</command> is intended to only be run once within
        a particular source tree. Use <filename>emdebuild</filename> <option>-n</option>
        to build subsequent releases from the same tree.
        </para>
    </note>
    <refsect2 id="todo">
      <title>TODO</title>
      <itemizedlist>
        <listitem>
          <para>A method to detect and override settings to run ./configure tests.</para>
        </listitem>
      </itemizedlist>
    </refsect2>
  </refsect1>
  <refsect1 id="options">
    <title>OPTIONS</title>
    <variablelist remap="TP">
      <varlistentry>
        <term><option>-a</option>|<option>--arch</option> ARCH</term>
        <listitem>
          <para>Specify the target architecture - used to check
              if a suitable toolchain exists. Default is set by
              <filename>dpkg-cross</filename> using debconf.
              </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>|<option>--verbose</option></term>
        <listitem>
          <para>be verbose - repeat once for extra verbosity.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-q</option>|<option>--quiet</option></term>
        <listitem>
          <para>be quiet.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>|<option>--help</option></term>
        <listitem>
          <para>print the usage message and exit.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--version</option>
        </term>
        <listitem>
          <para>print the usage message and exit.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>PROBLEMS</title>
    <para>Sometimes, <command>em_make</command> fails to recognise a
        split line in <filename>debian/rules</filename> and removes the
        first part of the command (e.g. <filename>dh_installdocs</filename>)
        but not the second - this causes a build failure, often
        <computeroutput>'Command not found'</computeroutput>. These problems
        show up in the <filename>../emdebian-rules.patch</filename> file
        and <filename>debian/rules</filename> needs to be edited to remove
        the stubs.</para>
    <para>This is a bug in <filename>em_make</filename> which should
        be fixed in future releases.
        </para>
  </refsect1>
  <refsect1>
    <title>MANUAL EDITING</title>
    <para>Manual editing of <filename>debian/rules</filename> is still
        necessary because not all packages use recognisable methods to
        install <command>info</command> or <command>man</command> pages.
        Ensure you check <filename>debian/rules</filename> for hand-crafted
        rules that install to <filename>/usr/share/man</filename>,
        <filename>/usr/share/info</filename> or <filename>/usr/share/doc</filename>
        and check the eventual packages with <filename>dpkg -c</filename> or
        <filename>deb-gview</filename>.</para>
    <para><command>lintian</command> and <command>linda</command>
        overrides are not currently used or needed in Emdebian but these files
        are very small. There is no particular Emdebian policy on these files, yet.
        </para>
    <para>Note that <filename>debc</filename> may need some help - specify the
        location of the emdebian .changes file (which itself is output as a result
        of <filename>emdebuild</filename> calling <filename>debsign</filename>
        at the end of a successful build).</para>
  </refsect1>
  <refsect1>
    <title>Author</title>
    <para><command>em_make</command> was written
      by Neil Williams <email>codehelp@debian.org</email>.
    </para>
    <para>This  manual  page  was  written by Neil Williams
      <email>codehelp@debian.org</email>
    </para>
  </refsect1>
  <refsect1 id="emmakeseealso">
    <title>SEE ALSO</title>
    <para>See also <filename>apt-cross</filename> (1),
        <filename>dpkg-cross</filename> (1),
        <emphasis>emdebian-tools</emphasis> (1).
        </para>
  </refsect1>
</refentry>