Skip to content

Doc fixes #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 38 commits into from
Sep 19, 2017
Merged

Doc fixes #690

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
71ac4d7
Removing obsolete default configuration: no need for proxy factory by…
fredericDelaporte Sep 15, 2017
80ed467
Second level cache: transaction requirement, obsolete links.
fredericDelaporte Sep 15, 2017
eb55fce
Upgrade preface links
fredericDelaporte Sep 16, 2017
d06bf0a
Modernize quickstart
fredericDelaporte Sep 16, 2017
a6a8209
Minor adjustments to architecture chapter.
fredericDelaporte Sep 16, 2017
231ea88
Update and sort dialects in configuration listing, and minor adjustments
fredericDelaporte Sep 16, 2017
a304eca
More alternatives to xml mapping, and minor adjustments.
fredericDelaporte Sep 16, 2017
9409064
Fixed typo.
fredericDelaporte Sep 16, 2017
7668fee
Minor adjustments to manipulating data
fredericDelaporte Sep 16, 2017
a962fa6
Removed obsolete references.
fredericDelaporte Sep 17, 2017
06812d2
Recommandation on transacting, minor cleanup.
fredericDelaporte Sep 17, 2017
716011a
Code formatting fixes.
fredericDelaporte Sep 17, 2017
6a25a52
Code format fix.
fredericDelaporte Sep 17, 2017
d7ebdf2
Minor fix.
fredericDelaporte Sep 17, 2017
d94d8a8
Typo
fredericDelaporte Sep 17, 2017
04c0634
Fix code formatting.
fredericDelaporte Sep 17, 2017
dfb7f00
Code formatting fixes.
fredericDelaporte Sep 17, 2017
37b5e9f
Removed references to abandonned or not ported tools.
fredericDelaporte Sep 17, 2017
d008c0f
Minor typo.
fredericDelaporte Sep 17, 2017
9f3718f
Fix and modernize weblog example
fredericDelaporte Sep 17, 2017
a2e42d3
Minor typo
fredericDelaporte Sep 17, 2017
4792d5d
Fixing a -- not supported in comment by doc tool.
fredericDelaporte Sep 17, 2017
fd2bd86
Added back missing property for doc generation
fredericDelaporte Sep 17, 2017
29e0afb
Fixing SHFB build by using msbuild.exe instead of dotnet
fredericDelaporte Sep 17, 2017
211d92f
Simplified msbuild script.
fredericDelaporte Sep 18, 2017
cee4a4d
Adjustment for having weblog working actually.
fredericDelaporte Sep 18, 2017
f9b1893
Fixing bad parameter names.
fredericDelaporte Sep 18, 2017
a75809c
Slightly more modern
fredericDelaporte Sep 18, 2017
e1ec5e7
Purging references to non-existent Find/Enumerable methods.
fredericDelaporte Sep 18, 2017
d43a83f
Fixing pdf overflows.
fredericDelaporte Sep 18, 2017
714f044
Tag fix
fredericDelaporte Sep 18, 2017
1e99d43
Fix example
fredericDelaporte Sep 18, 2017
46a3701
Removing references to non existent Filter method
fredericDelaporte Sep 18, 2017
c41d15c
Modernize: replace non generic by generic.
fredericDelaporte Sep 18, 2017
2239cf3
Modernize properties
fredericDelaporte Sep 18, 2017
41662b7
Fix non existent method (one more)
fredericDelaporte Sep 18, 2017
a742186
Fix sql query examples
fredericDelaporte Sep 18, 2017
7d07045
More links adjustments
fredericDelaporte Sep 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions doc/reference/modules/configuration.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,19 +324,15 @@ ISession session = sessions.OpenSession(conn);

<hibernate-configuration xmlns="urn:nhibernate-configuration-2.2">
<session-factory>
<property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>
<property name="dialect">NHibernate.Dialect.MsSql2012Dialect</property>
<property name="connection.connection_string">
Server=(local);initial catalog=theDb;Integrated Security=SSPI
</property>
<property name="connection.isolation">ReadCommitted</property>

<property name="proxyfactory.factory_class">
NHibernate.ByteCode.LinFu.ProxyFactoryFactory, NHibernate.ByteCode.LinFu
</property>
</session-factory>
</hibernate-configuration>

<!-- other app specific config follows -->
<!-- other app specific config follows -->
</configuration>]]></programlisting>

<para>
Expand Down
27 changes: 12 additions & 15 deletions doc/reference/modules/nhibernate_caches.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
<para>
Uses <classname>System.Web.Caching.Cache</classname> as the cache provider. This means that you can
rely on ASP.NET caching feature to understand how it works. For more information, read (on the MSDN):
<ulink url="http://msdn.microsoft.com/library/en-us/cpguide/html/cpconcacheapis.asp">Caching Application Data</ulink>.
<ulink url="https://msdn.microsoft.com/en-us/library/6hbbsfk6.aspx">Caching Application Data</ulink>.
</para>
</listitem>
</varlistentry>
Expand All @@ -75,7 +75,7 @@
<term><classname>NHibernate.Caches.MemCache</classname></term>
<listitem>
<para>
Uses <literal>memcached</literal>. See <ulink url="http://www.danga.com/memcached/">memcached homepage</ulink>
Uses <literal>memcached</literal>. See <ulink url="http://memcached.org/">memcached homepage</ulink>
for more information.
</para>
</listitem>
Expand All @@ -84,9 +84,9 @@
<term><classname>NCache provider for NHibernate</classname></term>
<listitem>
<para>
Uses <literal>NCache</literal>,NCache is a commercial distributed caching system with a provider for NHibernate.
Uses <literal>NCache</literal>. NCache is a commercial distributed caching system with a provider for NHibernate.
The NCache Express version is free for use, see
<ulink url="http://www.alachisoft.com/ncache/ncache_express.html">NCache Express homepage</ulink>
<ulink url="http://www.alachisoft.com/ncache/">NCache Express homepage</ulink>
for more information.
</para>
</listitem>
Expand Down Expand Up @@ -153,7 +153,15 @@
they are destroyed with the SessionFactory instance; so you must keep them alive as long as you need
them.
</para>
<para>
The second level cache requires the use of transactions, be it through transaction scopes or NHibernate
transactions. Interacting with the data store without an explicit transaction is discouraged, and will
not allow the second level cache to work as intended.
</para>
</formalpara>
<para>
See also <xref linkend="performance-cache" />.
</para>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have two separated section documenting second level cache, each with valuable information not available in the other. It would be better to merge them. At least I add a cross link here. (The other side already does it.)

</section>

<section id="NHibernate.Caches.Prevalence">
Expand Down Expand Up @@ -480,17 +488,6 @@
</variablelist>
</section>

<section>
<title>Patches</title>

<para>
There is a known issue where some SQL Server 2005 notifications might not be received when an
application subscribes to query notifications by using ADO.NET 2.0. To fix this problem install
<ulink url="http://support.microsoft.com/Default.aspx?kbid=913364">SQL hotfix for kb 913364</ulink>.
</para>
Copy link
Member Author

@fredericDelaporte fredericDelaporte Sep 15, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link dead, kb not found anymore, probably merged in a SQL 2005 SP since long.


</section>

</section>

</chapter>
8 changes: 7 additions & 1 deletion doc/reference/modules/performance.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,13 @@ ICat fritz = (ICat) iter.Current;]]></programlisting>
<emphasis>In NHibernate 1.x the second level cache does not work correctly in combination with
distributed transactions.</emphasis>
</para>


<para>
The second level cache requires the use of transactions, be it through transaction scopes or NHibernate
transactions. Interacting with the data store without an explicit transaction is discouraged, and will
not allow the second level cache to work as intended.
</para>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One frequent cause of complains about second level cache not working.


<para>
By default, NHibernate uses HashtableCache for process-level caching. You may choose a different
implementation by specifying the name of a class that implements <literal>NHibernate.Cache.ICacheProvider</literal>
Expand Down
4 changes: 1 addition & 3 deletions doc/reference/modules/quickstart.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@
configuration elements according to the listing below:
</para>

<programlisting>
<![CDATA[<?xml version="1.0" encoding="utf-8" ?>
<programlisting><![CDATA[<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<!-- Add this element -->
<configSections>
Expand All @@ -57,7 +56,6 @@
<property name="dialect">NHibernate.Dialect.MsSql2005Dialect</property>
<property name="connection.provider">NHibernate.Connection.DriverConnectionProvider</property>
<property name="connection.connection_string">Server=localhost\SQLEXPRESS;initial catalog=quickstart;Integrated Security=True</property>
<property name="proxyfactory.factory_class">NHibernate.ByteCode.LinFu.ProxyFactoryFactory, NHibernate.ByteCode.LinFu</property>

<mapping assembly="QuickStart" />
</session-factory>
Expand Down