Skip to content

Commit

Permalink
Updated Manual for 2.3.34 release
Browse files Browse the repository at this point in the history
  • Loading branch information
ddekany committed Dec 1, 2024
1 parent b0d4ffd commit 19e99c6
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions freemarker-manual/src/main/docgen/en_US/book.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10434,22 +10434,22 @@ cfg.setNumberFormat("@ua 0.####;; roundingMode=halfUp");</programlisting>
<literal>freemarker.template.Configuration</literal> object
like:</para>

<programlisting role="unspecified">... = new Configuration(Configuration.VERSION_2_3_28)</programlisting>
<programlisting role="unspecified">... = new Configuration(Configuration.VERSION_2_3_34)</programlisting>
</listitem>

<listitem>
<para>Or, alter the <literal>Configuration</literal> singleton
where you initialize its other settings like:</para>

<programlisting role="unspecified">cfg.setIncompatibleImprovements(Configuration.VERSION_2_3_28)</programlisting>
<programlisting role="unspecified">cfg.setIncompatibleImprovements(Configuration.VERSION_2_3_34)</programlisting>
</listitem>

<listitem>
<para>Or, if you are configuring FreeMarker with properties
(<literal>*.properties</literal> file or
<literal>java.util.Properties</literal> object), add:</para>

<programlisting role="unspecified">incompatible_improvements=2.3.28</programlisting>
<programlisting role="unspecified">incompatible_improvements=2.3.34</programlisting>
</listitem>

<listitem>
Expand All @@ -10460,7 +10460,7 @@ cfg.setNumberFormat("@ua 0.####;; roundingMode=halfUp");</programlisting>

<programlisting role="unspecified">&lt;init-param&gt;
&lt;param-name&gt;incompatible_improvements&lt;/param-name&gt;
&lt;param-value&gt;2.3.28&lt;/param-value&gt;
&lt;param-value&gt;2.3.34&lt;/param-value&gt;
&lt;/init-param&gt;</programlisting>
</listitem>
</itemizedlist>
Expand Down Expand Up @@ -10497,7 +10497,7 @@ cfg.setNumberFormat("@ua 0.####;; roundingMode=halfUp");</programlisting>
<para>Do not ever use
<literal>Configuration.getVersion()</literal> to set the
<quote>incompatible improvements</quote> setting. Always use a
fixed value, like <literal>Configuration.VERSION_2_3_28</literal>.
fixed value, like <literal>Configuration.VERSION_2_3_34</literal>.
Otherwise your application can break as you upgrade FreeMarker.
The whole point of <quote>incompatible improvements</quote> is to
protect you from that, while you still always get the
Expand Down Expand Up @@ -30458,7 +30458,7 @@ TemplateModel x = env.getVariable("x"); // get variable x</programlisting>
<section xml:id="versions_2_3_34">
<title>2.3.34</title>

<para>Release date: TODO</para>
<para>Release date: 2024-12-01 + release process</para>

<section>
<title>Changes on the FTL side</title>
Expand Down Expand Up @@ -31556,8 +31556,8 @@ TemplateModel x = env.getVariable("x"); // get variable x</programlisting>
This applies to said setting of
<literal>Configuration</literal>,
<literal>DefaultObjectWrapper</literal>, and
<literal>BeansWrapper</literal>. The typical bad pattern is
this: <literal>new
<literal>BeansWrapper</literal>. The typical
<emphasis>bad</emphasis> pattern is this: <literal>new
Configuration(Configuration.getVersion())</literal>. Doing that
defeats the purpose of
<literal>incompatibleImprovements</literal>, and makes upgrading
Expand Down

0 comments on commit 19e99c6

Please sign in to comment.