summaryrefslogtreecommitdiff
path: root/docs/src/opie-policy/core/core.sgml
blob: edd10754189c24c1cb4ea838c999b929f95b03e8 (plain)
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
<chapter id="core">
  <title>Core Opie Policies</title>
  <sect1 id="imagepolicy"><title>Image Policy</title>
  <para>
  This section outlines policies with regard to images in Opie.  Specifically, concerns regarding the structure of the pics/ subdirectory are addressed.
  <itemizedlist><title>Primary Declarations</title>
    <listitem>
      <para>
      All generally <emphasis>useful</emphasis> images are to be inlined.
      </para>
    </listitem>
    <listitem>
      <para>
      All images which are used by more than one Opie core application are to be inlined.
      </para>
    </listitem>
    <listitem>
      <para>
      All images specific to one core application are to be moved into a pics/ subdirectory of the application's directory, and are to be packaged with the application.
      </para>
    </listitem>
    <listitem>
      <para>
      All other images are to be kept for compatibility reasons and are to be packaged in a opie-extrapics package.  The opie-pics package will no longer exist, and no images will reside in the root of pics/.
      </para>
    </listitem>
  </itemizedlist>
  </para>
  </sect1>
  <sect1 id="librarypolicy"><title>Qtopia Compatibility</title>
    <para>
    This section outlines the stance of Opie with regard to compatibility with Qtopia.  Testing must be done on a regular basis to ensure that this is still the case.  Our applications must work in a Qtopia environment, and vice versa.
    <itemizedlist><title>Primary Declarations</title>
      <listitem>
        <para>
        Binary compatibility is to be retained with Qtopia, in both directions.
        </para>
      </listitem>
      <listitem>
        <para>
        The libqpe library is not to be altered in such a way that compatibility is broken.
        </para>
      </listitem>
      <listitem>
        <para>
        Functions may be added to the library, as long as that does not affect compatibility, and as long as said functions are used ONLY internally.
        </para>
      </listitem>
      <listitem>
        <para>
        Existing functions are not to be altered in an unexpected way.
        </para>
      </listitem>
    </itemizedlist>
    </para>
  </sect1>
  <sect1 id="corevsnoncore"><title>Core/NonCore</title>
  <para>
  This section outlines policies and guidelines with regard to the core/noncore seperation.
  <itemizedlist><title>Primary Declarations</title>
    <listitem>
      <para>
      NULL
      </para>
    </listitem>
  </itemizedlist>
  </para>
  </sect1>
</chapter>