Attachment #5832 for bug #32743

Lines 25-31 Link Here

(-)a/branches/ucs-3.2/doc-common/docbook/stylesheets/macros-de.ent (-1 / +1 lines)
25		25
26	<!ENTITY ar "->" >	26	<!ENTITY ar "->" >
27		27
28	<!ENTITY websvn "http://forge.univention.org/svn/dev/branches/ucs-3.2/ucs-3.2-0/" >	28	<!ENTITY websvn "http://forge.univention.org/svn/dev/branches/ucs-3.2/ucs-3.2-1/" >
29	<!ENTITY webdoc "http://docs.univention.de/" >	29	<!ENTITY webdoc "http://docs.univention.de/" >
30	<!ENTITY ucsbug "https://forge.univention.org/bugzilla/show_bug.cgi?id=" >	30	<!ENTITY ucsbug "https://forge.univention.org/bugzilla/show_bug.cgi?id=" >
31	<!ENTITY cve "http://cve.mitre.org/cgi-bin/cvename.cgi?name=" >	31	<!ENTITY cve "http://cve.mitre.org/cgi-bin/cvename.cgi?name=" >

Lines 25-31 Link Here

(-)a/branches/ucs-3.2/doc-common/docbook/stylesheets/macros-en.ent (-1 / +1 lines)
25		25
26	<!ENTITY ar "->" >	26	<!ENTITY ar "->" >
27		27
28	<!ENTITY websvn "http://forge.univention.org/svn/dev/branches/ucs-3.2/ucs-3.2-0/" >	28	<!ENTITY websvn "http://forge.univention.org/svn/dev/branches/ucs-3.2/ucs-3.2-1/" >
29	<!ENTITY webdoc "http://docs.univention.de/" >	29	<!ENTITY webdoc "http://docs.univention.de/" >
30	<!ENTITY ucsbug "https://forge.univention.org/bugzilla/show_bug.cgi?id=" >	30	<!ENTITY ucsbug "https://forge.univention.org/bugzilla/show_bug.cgi?id=" >
31	<!ENTITY cve "http://cve.mitre.org/cgi-bin/cvename.cgi?name=" >	31	<!ENTITY cve "http://cve.mitre.org/cgi-bin/cvename.cgi?name=" >




		<para>
			A unique upload ID will be displayed after the download that has to be
			forwarded to Univention. Please send the following information via e-mail
			to <ulink url="mailto:appcenter@univention.de"><email>appcenter@univention.de</email></ulink>:
					url="mailto:appcenter@univention.de">appcenter@univention.de</ulink></email>:
			<itemizedlist>
				<listitem><simpara>
					Upload ID for the file archive. Please provide all upload IDs if the

			Updates for the application description (.ini file), the product logo,
			the screenshot, readme files (especially
			<literal>README_UPDATE</literal>) and the packages are all submitted to
			<ulink url="mailto:appcenter@univention.de"><email>appcenter@univention.de</email></ulink>.
					url="mailto:appcenter@univention.de">appcenter@univention.de</ulink></email>.
			Only those files that changed need to be uploaded again, everything else
			can be copied by Univention. The ini file needs to change every time,
			because the <literal>Version</literal> has to be increased. If this is

Lines 33-40 Link Here

(-)a/branches/ucs-3.2/ucs-3.2-1/doc/developer-reference/developer-reference-3.2.xml (-2 / +2 lines)
33	</legalnotice>	33	</legalnotice>
34	<revhistory>	34	<revhistory>
35	<revision>	35	<revision>
36	<revnumber>3.2-0</revnumber>	36	<revnumber>3.2-1</revnumber>
37	<date>19th of November 2013</date>	37	<date>17th of March 2014</date>
38	</revision>	38	</revision>
39	</revhistory>	39	</revhistory>
40	</bookinfo>	40	</bookinfo>

Lines 13-19 Link Here

(-)a/branches/ucs-3.2/ucs-3.2-1/doc/developer-reference/introduction.xml (-1 / +1 lines)
13		13
14	<para>	14	<para>
15	Feedback is very welcome! Please either file a bug (see <xref linkend="chap:bug"/>) or send an	15	Feedback is very welcome! Please either file a bug (see <xref linkend="chap:bug"/>) or send an
16	e-mail to feedback@univention.de	16	e-mail to <ulink url="mailto:feedback@univention.de"><email>feedback@univention.de</email></ulink>.
17	</para>	17	</para>
18		18
19	</preface>	19	</preface>




			</example>
			<para>
				Modifying variables requires a different approach.
				The function <function>ucr_update()</function> should be used to set and unset variables.
			</para>
			<example>
				<title>Changing &ucsUCRV;s in Python</title>
				<programlisting><![CDATA[
from univention.config_registry.handler import ucr_update
ucr_update(ucr, {
	'foo': 'bar',
	'baz': '42',
	'bar': None,
	})
				]]></programlisting>
			</example>
			<para>
				The function <function>ucr_update()</function> requires an instance of <classname>ConfigRegistry</classname> as its first argument.
				The method is guaranteed to be atomic and internally uses file locking to prevent race conditions.
			</para>
			<para>
				The second argument must be a Python dictionary mapping <acronym>UCR</acronym> variable names to their new value.
				The value must be either a string or <constant>None</constant>, which is used to unset the variable.
			</para>
		</section>
	</section>

		<remark>SG: Move this to a sample package</remark>
		<para>
			This sections contains several simple examples for the use of &ucsUCR;.
			The complete source of these examples is available separately.
			The download location is given in each example below.
			Since almost all &ucsUCS; packages use <acronym>UCR</acronym>, their source code provides additional examples.
		</para>


Return to bug 32743

Lines 605-612 Link Here

(-)a/branches/ucs-3.2/ucs-3.2-1/doc/developer-reference/apps/app.xml (-4 / +2 lines)
605	<para>	605	<para>
606	A unique upload ID will be displayed after the download that has to be	606	A unique upload ID will be displayed after the download that has to be
607	forwarded to Univention. Please send the following information via e-mail	607	forwarded to Univention. Please send the following information via e-mail
608	to <email><ulink	608	to <ulink url="mailto:appcenter@univention.de"><email>appcenter@univention.de</email></ulink>:
609	url="mailto:appcenter@univention.de">appcenter@univention.de</ulink></email>:
610	<itemizedlist>	609	<itemizedlist>
611	<listitem><simpara>	610	<listitem><simpara>
612	Upload ID for the file archive. Please provide all upload IDs if the	611	Upload ID for the file archive. Please provide all upload IDs if the
Lines 697-704 Link Here
697	Updates for the application description (.ini file), the product logo,	696	Updates for the application description (.ini file), the product logo,
698	the screenshot, readme files (especially	697	the screenshot, readme files (especially
699	<literal>README_UPDATE</literal>) and the packages are all submitted to	698	<literal>README_UPDATE</literal>) and the packages are all submitted to
700	<email><ulink	699	<ulink url="mailto:appcenter@univention.de"><email>appcenter@univention.de</email></ulink>.
701	url="mailto:appcenter@univention.de">appcenter@univention.de</ulink></email>.
702	Only those files that changed need to be uploaded again, everything else	700	Only those files that changed need to be uploaded again, everything else
703	can be copied by Univention. The ini file needs to change every time,	701	can be copied by Univention. The ini file needs to change every time,
704	because the <literal>Version</literal> has to be increased. If this is	702	because the <literal>Version</literal> has to be increased. If this is

Lines 203-223 if ucr.is_false('repository/online/unmaintained', True): Link Here

(-)a/branches/ucs-3.2/ucs-3.2-1/doc/developer-reference/ucr/ucr.xml (-9 / +15 lines)
203	</example>	203	</example>
204	<para>	204	<para>
205	Modifying variables requires a different approach.	205	Modifying variables requires a different approach.
206	Two functions <function>handler_set()</function> and <function>handler_unset()</function> can be used to set and unset variables.	206	The function <function>ucr_update()</function> should be used to set and unset variables.
207	</para>	207	</para>
208	<example>	208	<example>
209	<title>Changing &ucsUCRV;s in Python</title>	209	<title>Changing &ucsUCRV;s in Python</title>
210	<programlisting><![CDATA[	210	<programlisting><![CDATA[
211	from univention.config_registry import handler_set, handler_unset	211	from univention.config_registry.handler import ucr_update
212	handler_set([	212	ucr_update(ucr, {
213	'foo=bar',	213	'foo': 'bar',
214	'baz=42',	214	'baz': '42',
215	])	215	'bar': None,
216	handler_unset(['foo', 'bar'])	216	})
217	]]></programlisting>	217	]]></programlisting>
218	</example>	218	</example>
219	<para>	219	<para>
220	As <function>handler_set()</function> and <function>handler_unset()</function> don't automatically update any instance of <classname>ConfigRegistry</classname>, the <methodname>load()</methodname> method has to be called manually afterwards to reflect the updated values.	220	The function <function>ucr_update()</function> requires an instance of <classname>ConfigRegistry</classname> as its first argument.
		221	The method is guaranteed to be atomic and internally uses file locking to prevent race conditions.
		222	</para>
		223	<para>
		224	The second argument must be a Python dictionary mapping <acronym>UCR</acronym> variable names to their new value.
		225	The value must be either a string or <constant>None</constant>, which is used to unset the variable.
221	</para>	226	</para>
222	</section>	227	</section>
223	</section>	228	</section>
Lines 910-916 Depends: ..., ${misc:Depends}, ... Link Here
910	<remark>SG: Move this to a sample package</remark>	915	<remark>SG: Move this to a sample package</remark>
911	<para>	916	<para>
912	This sections contains several simple examples for the use of &ucsUCR;.	917	This sections contains several simple examples for the use of &ucsUCR;.
913	The complete source of these examples is available separately. <!-- TODO: svn link? -->	918	The complete source of these examples is available separately.
		919	The download location is given in each example below.
914	Since almost all &ucsUCS; packages use <acronym>UCR</acronym>, their source code provides additional examples.	920	Since almost all &ucsUCS; packages use <acronym>UCR</acronym>, their source code provides additional examples.
915	</para>	921	</para>
916		922