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.

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
Show file tree
Hide file tree
Changes from all 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
11 changes: 11 additions & 0 deletions Tools/actual_msbuild.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
@echo off

for /f "usebackq tokens=*" %%i in (`%~dp0\vswhere.2.1.4\tools\vswhere -latest -products * -requires Microsoft.Component.MSBuild -property installationPath`) do (
set InstallDir=%%i
)

if exist "%InstallDir%\MSBuild\15.0\Bin\MSBuild.exe" (
"%InstallDir%\MSBuild\15.0\Bin\MSBuild.exe" %*
) else (
exit /b -1
)
1 change: 1 addition & 0 deletions Tools/packages.config
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
<package id="NUnit.Extension.TeamCityEventListener" version="1.0.2" targetFramework="net461" />
<package id="NUnit.Extension.VSProjectLoader" version="3.6.0" targetFramework="net461" />
<package id="CSharpAsyncGenerator.CommandLine" version="0.4.4" targetFramework="net461" />
<package id="vswhere" version="2.1.4" targetFramework="net461" />
</packages>
1 change: 1 addition & 0 deletions build-common/common.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
<!-- This is used only for build folder -->
<!-- TODO: Either remove or refactor to use NHibernate.props -->
<property name="project.version" value="5.0.0-Alpha1" overwrite="false" />
<property name="project.version.numeric" value="5.0.0" overwrite="false" />

<!-- debug|release -->
<property name="build.defines" value="" />
Expand Down
4 changes: 2 additions & 2 deletions doc/documentation.build
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@
<echo if="${api.uptodate}">API documentation is up to date, skipping generation step.</echo>

<if test="${not api.uptodate}">
<exec program="${path::combine(tools.dir, 'msbuild.cmd')}">
<exec program="${path::combine(tools.dir, 'actual_msbuild.cmd')}">
<arg line="NHibernate.shfbproj" />
</exec>
</if>
</target>

</project>
</project>
2 changes: 0 additions & 2 deletions doc/reference/master.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
<!ENTITY nhc-preface SYSTEM "modules/nhibernatecontrib_preface.xml">
<!ENTITY nhcaches-chapter SYSTEM "modules/nhibernate_caches.xml">
<!ENTITY nhma-chapter SYSTEM "modules/nhibernate_mapping_attributes.xml">
<!ENTITY nhbm2net-chapter SYSTEM "modules/nhibernate_tool_hbm2net.xml">
<!ENTITY nullables-chapter SYSTEM "modules/nullables.xml">
]>


Expand Down
11 changes: 6 additions & 5 deletions doc/reference/modules/architecture.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
</mediaobject>

<para>
Heres some definitions of the objects in the diagrams:
Here are some definitions of the objects in the diagrams:

<variablelist spacing="compact">
<varlistentry>
Expand Down Expand Up @@ -122,7 +122,8 @@
(Optional) A single-threaded, short-lived object used by the application to
specify atomic units of work. Abstracts application from underlying ADO.NET
transaction. An <literal>ISession</literal> might span several
<literal>ITransaction</literal>s in some cases.
<literal>ITransaction</literal>s in some cases. Transaction scopes may be used
instead.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -227,7 +228,7 @@
Starting with version 1.2, NHibernate added the <literal>ISessionFactory.GetCurrentSession()</literal>
method. The processing behind <literal>ISessionFactory.GetCurrentSession()</literal> is pluggable.
An extension interface (<literal>NHibernate.Context.ICurrentSessionContext</literal>) and a new
configuration parameter (<literal>hibernate.current_session_context_class</literal>) have been added
configuration parameter (<literal>current_session_context_class</literal>) have been added
to allow pluggability of the scope and context of defining current sessions.
</para>
<para>
Expand All @@ -245,7 +246,7 @@
by current asynchronous flow. You are responsible to bind and unbind an
<literal>ISession</literal> instance with static methods of class
<literal>CurrentSessionContext</literal>. Binding operations from inner flows will not be
propagated to outer or siblings flows.
propagated to outer or siblings flows. Added in NHibernate 5.0.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -293,7 +294,7 @@
</itemizedlist>

<para>
The <literal>hibernate.current_session_context_class</literal> configuration parameter
The <literal>current_session_context_class</literal> configuration parameter
defines which <literal>NHibernate.Context.ICurrentSessionContext</literal> implementation
should be used. Typically, the value of this parameter would just name the implementation
class to use (including the assembly name); for the out-of-the-box implementations, however,
Expand Down
16 changes: 10 additions & 6 deletions doc/reference/modules/basic_mapping.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
Note that, even though many NHibernate users choose to define XML mappings by hand,
a number of tools exist to generate the mapping document, including
NHibernate.Mapping.Attributes library and various template-based code
generators (CodeSmith, MyGeneration).
generators (CodeSmith, MyGeneration). You may also use
<literal>NHibernate.Mapping.ByCode</literal> available since NHibernate 3.2, or
<ulink url="https://github.com/jagregory/fluent-nhibernate">Fluent NHibernate</ulink>.
</para>

<para>
Expand Down Expand Up @@ -614,8 +616,9 @@
<listitem>
<para>
uses the algorithm to generate a new <literal>System.Guid</literal>
described by Jimmy Nilsson in the article
http://www.informit.com/articles/article.asp?p=25862.
described by Jimmy Nilsson in
<ulink url="https://www.informit.com/articles/article.aspx?p=25862">this
article</ulink>.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -2929,9 +2932,10 @@
are possible.
</para>

<programlisting><![CDATA[<property name="TwoStrings" type="NHibernate.DomainModel.DoubleStringType, NHibernate.DomainModel">
<column name="first_string"/>
<column name="second_string"/>
<programlisting><![CDATA[<property name="TwoStrings"
type="NHibernate.DomainModel.DoubleStringType, NHibernate.DomainModel">
<column name="first_string"/>
<column name="second_string"/>
</property>]]></programlisting>

<para>
Expand Down
7 changes: 5 additions & 2 deletions doc/reference/modules/batch.xml
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,8 @@ using (ITransaction tx = session.BeginTransaction())
<programlisting><![CDATA[using (ISession session = sessionFactory.OpenSession())
using (ITransaction tx = session.BeginTransaction())
{
string hqlVersionedUpdate = "update versioned Customer set name = :newName where name = :oldName";
string hqlVersionedUpdate =
"update versioned Customer set name = :newName where name = :oldName";
int updatedEntities = s.CreateQuery(hqlUpdate)
.SetString("newName", newName)
.SetString("oldName", oldName)
Expand Down Expand Up @@ -313,7 +314,9 @@ using (ITransaction tx = session.BeginTransaction())
<programlisting><![CDATA[using (ISession session = sessionFactory.OpenSession())
using (ITransaction tx = session.BeginTransaction())
{
var hqlInsert = "insert into DelinquentAccount (id, name) select c.id, c.name from Customer c where ...";
var hqlInsert =
"insert into DelinquentAccount (id, name) " +
"select c.id, c.name from Customer c where ...";
int createdEntities = s.CreateQuery(hqlInsert)
.ExecuteUpdate();
tx.Commit();
Expand Down
Loading