Skip to content

Commit

Permalink
HHH-12892 - Fix spelling issues in the User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
vladmihalcea committed Aug 13, 2018
1 parent c55f3de commit 6c5e172
Show file tree
Hide file tree
Showing 53 changed files with 419 additions and 418 deletions.
Expand Up @@ -11,7 +11,7 @@ It will also delve into the ways third-party integrators and applications can le
=== What is a Service?

A services provides a certain types of functionality, in a pluggable manner.
Specifically they are interfaces defining certain functionality and then implementations of those `Service` contract interfaces.
Specifically, they are interfaces defining certain functionality and then implementations of those `Service` contract interfaces.
The interface is known as the `Service` role; the implementation class is known as the `Service` implementation.
The pluggability comes from the fact that the `Service` implementation adheres to contract defined by the interface of the `Service` role and that consumers of the `Service` program to the `Service` role, not the implementation.

Expand Down
Expand Up @@ -3,7 +3,7 @@
[preface]
== Preface

Working with both Object-Oriented software and Relational Databases can be cumbersome and time consuming.
Working with both Object-Oriented software and Relational Databases can be cumbersome and time-consuming.
Development costs are significantly higher due to a paradigm mismatch between how data is represented in objects
versus relational databases. Hibernate is an Object/Relational Mapping (ORM) solution for Java environments. The
term Object/Relational Mapping refers to the technique of mapping data between an object model representation to
Expand Down
Expand Up @@ -58,7 +58,7 @@ There are other ways to specify configuration properties, including:
* Place a file named hibernate.properties in a root directory of the classpath.
* Place a file named hibernate.properties in a root directory of the classpath.
* Pass an instance of java.util.Properties to `Configuration#setProperties`.
* Set System properties using java `-Dproperty=value`.
* Set System properties using Java `-Dproperty=value`.
* Include `<property/>` elements in `hibernate.cfg.xml`


Expand Down
Expand Up @@ -4,7 +4,7 @@
This guide discusses the process of bootstrapping a Hibernate `org.hibernate.SessionFactory`. It also
discusses the ways in which applications and integrators can hook-in to and affect that process. This
bootstrapping process is defined in 2 distinct steps. The first step is the building of a ServiceRegistry
holding the services Hibernate will need at bootstrap- and run-time. The second step is the building of
holding the services Hibernate will need at bootstrap- and runtime. The second step is the building of
a Metadata object representing the mapping information for the application's model and its mapping to
the database.

Expand Down
Expand Up @@ -23,11 +23,11 @@ Ultimately all enhancement is handled by the `org.hibernate.bytecode.enhance.spi
enhancement can certainly be crafted on top of Enhancer, but that is beyond the scope of this guide. Here we
will focus on the means Hibernate already exposes for performing these enhancements.

=== Run-time enhancement
=== Runtime enhancement

Currently run-time enhancement of the domain model is only supported in managed JPA environments following the JPA defined SPI for performing class transformations.
Currently runtime enhancement of the domain model is only supported in managed JPA environments following the JPA defined SPI for performing class transformations.

Even then, this support is disabled by default. To enable run-time enhancement, specify one of the following configuration properties:
Even then, this support is disabled by default. To enable runtime enhancement, specify one of the following configuration properties:

`*hibernate.enhancer.enableDirtyTracking*` (e.g. `true` or `false` (default value))::
Enable dirty tracking feature in runtime bytecode enhancement.
Expand Down
Expand Up @@ -187,7 +187,7 @@ http://sourceforge.net/projects/hibernate/files/hibernate4[SourceForge].
In most cases the annotation processor will automatically run provided
the processor jar is added to the build classpath and a JDK >6 is used.
This happens due to Java's Service Provider contract and the fact
the the Hibernate Static Metamodel Generator jar files contains the
the Hibernate Static Metamodel Generator jar files contains the
file _javax.annotation.processing.Processor_ in the _META-INF/services_ directory.

The fully qualified name of the processor itself is:
Expand Down
Expand Up @@ -12,7 +12,7 @@ applications can leverage and customize Services and Registries.

== What is a Service?

Services provide various types of functionality, in a pluggable manner. Specifically they are interfaces defining
Services provide various types of functionality, in a pluggable manner. Specifically, they are interfaces defining
certain functionality and then implementations of those service contract interfaces. The interface is known as the
service role; the implementation class is known as the service implementation. The pluggability comes from the fact
that the service implementation adheres to contract defined by the interface of the service role and that consumers
Expand Down
6 changes: 3 additions & 3 deletions documentation/src/main/asciidoc/topical/wildfly/Wildfly.adoc
Expand Up @@ -266,9 +266,9 @@ By convention all modules included with WildFly use the "main" slot, while the m
will use a slot name which matches the version, and also provide an alias to match its "major.minor" version.

Our suggestion is to depend on the module using the "major.minor" representation, as this simplifies rolling out bugfix
releases (micro version updates) of Hibernate ORM without changing application configuration (micro versions are always expected to be backwards compatible and released as bugfix only).
releases (micro version updates) of Hibernate ORM without changing application configuration (micro versions are always expected to be backward compatible and released as bugfix only).

For example if your application wants to use the latest version of Hibernate ORM version {majorMinorVersion}.x it should declare to use the module _org.hibernate:{majorMinorVersion}_. You can of course decide to use the full version instead for more precise control, in case an application requires a very specific version.
For example, if your application wants to use the latest version of Hibernate ORM version {majorMinorVersion}.x it should declare to use the module _org.hibernate:{majorMinorVersion}_. You can of course decide to use the full version instead for more precise control, in case an application requires a very specific version.

== Switch to a different Hibernate ORM slot

Expand Down Expand Up @@ -311,7 +311,7 @@ you might want to check it out as it lists several other useful properties.

When using the custom modules provided by the feature packs you're going to give up on some of the integration which the application server normally automates.

For example enabling an Infinispan 2nd level cache is straight forward when using the default Hibernate ORM
For example, enabling an Infinispan 2nd level cache is straight forward when using the default Hibernate ORM
module, as WildFly will automatically setup the dependency to the Infinispan and clustering components.
When using these custom modules such integration will no longer work automatically: you can still
enable all normally available features but these will require explicit configuration, as if you were
Expand Down
4 changes: 2 additions & 2 deletions documentation/src/main/asciidoc/userguide/Preface.adoc
@@ -1,10 +1,10 @@
[[preface]]
== Preface

Working with both Object-Oriented software and Relational Databases can be cumbersome and time consuming.
Working with both Object-Oriented software and Relational Databases can be cumbersome and time-consuming.
Development costs are significantly higher due to a paradigm mismatch between how data is represented in objects versus relational databases.
Hibernate is an Object/Relational Mapping solution for Java environments.
The term http://en.wikipedia.org/wiki/Object-relational_mapping[Object/Relational Mapping] refers to the technique of mapping data from an object model representation to a relational data model representation (and visa versa).
The term http://en.wikipedia.org/wiki/Object-relational_mapping[Object/Relational Mapping] refers to the technique of mapping data from an object model representation to a relational data model representation (and vice versa).

Hibernate not only takes care of the mapping from Java classes to database tables (and from Java data types to SQL data types), but also provides data query and retrieval facilities.
It can significantly reduce development time otherwise spent with manual data handling in SQL and JDBC.
Expand Down

0 comments on commit 6c5e172

Please sign in to comment.