doc/bestpract.xml

   1
   2 <!--
   3 $Id$
   4 $LastChangedBy$
   5 -->
   6         <section id="bestpract"><title>Best Practices When Creating Keys</title>
   7                 <para>When using Elektra to store your application's configuration and state, please keep in mind the following rules:</para>
   8                         <itemizedlist>
   9                                 <listitem><para>You are not allowed to create keys right under <filename>system</filename> or <filename>user</filename>.</para></listitem>
  10
  11                                 <listitem><para>You are not allowed to create folder keys right under <filename>system</filename> or <filename>user</filename>. They are reserved for very essential OS subsystems.</para></listitem>
  12
  13                                 <listitem><para>The keys for your application, called say <replaceable>MyApp</replaceable>, should be created under <filename>system/sw/MyApp</filename> and/or <filename>user/sw/MyApp</filename>.</para></listitem>
  14                         </itemizedlist>
  15         </section>
  16
  17