You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-dev@db.apache.org by mb...@apache.org on 2020/04/30 19:29:40 UTC
[db-jdo-site] 01/01: JDO-779: doc changes (pmf, source-code,
team-list)
This is an automated email from the ASF dual-hosted git repository.
mbo pushed a commit to branch remove-svn
in repository https://gitbox.apache.org/repos/asf/db-jdo-site.git
commit 4a73c96f463a1075bd16d246ea10d803ff3de3b3
Author: Michael Bouschen <Mi...@akquinet.de>
AuthorDate: Thu Apr 30 21:29:07 2020 +0200
JDO-779: doc changes (pmf, source-code, team-list)
- Introduced a table describing the standard properties in pmf.adoc
- Added git description replacing subversion doc
- Updated team list
---
src/main/asciidoc/pmf.adoc | 334 ++++++++----------------------------
src/main/asciidoc/source-code.adoc | 41 +++++
src/main/asciidoc/svn.adoc | 238 -------------------------
src/main/asciidoc/team-list.adoc | 24 ++-
src/main/template/document.html.erb | 2 +-
5 files changed, 123 insertions(+), 516 deletions(-)
diff --git a/src/main/asciidoc/pmf.adoc b/src/main/asciidoc/pmf.adoc
index 9bb20bf..29850e7 100644
--- a/src/main/asciidoc/pmf.adoc
+++ b/src/main/asciidoc/pmf.adoc
@@ -63,328 +63,134 @@ define the datastore that it should connect to.
=== Standard JDO Propertiesanchor:Standard_JDO_Properties[]
-*javax.jdo.PersistenceManagerFactoryClass*
-
-Description
-
-The name of the PersistenceManager implementation
-
-{empty} +
-
-
-*javax.jdo.option.ConnectionFactory*
-
-Description
-
-Instance of a connection factory. For RBDMS, it must be an instance of
+[cols=",",options="header",]
+|===
+|Name |Description
+|*javax.jdo.PersistenceManagerFactoryClass*
+|The name of the PersistenceManager implementation
+
+|*javax.jdo.option.ConnectionFactory*
+| Instance of a connection factory. For RBDMS, it must be an instance of
javax.sql.DataSource. *This is for a transactional DataSource*
-{empty} +
-
-
-*javax.jdo.option.ConnectionFactory2*
-
-Description
-
-Instance of a connection factory. For RBDMS, it must be an instance of
+|*javax.jdo.option.ConnectionFactory2*
+|Instance of a connection factory. For RBDMS, it must be an instance of
javax.sql.DataSource. *This is for a non-transactional DataSource*
-{empty} +
-
-
-*javax.jdo.option.ConnectionFactoryName*
-
-Description
-
-The JNDI name for a connection factory. For RBDMS, it must be a JNDI
+|*javax.jdo.option.ConnectionFactoryName*
+|The JNDI name for a connection factory. For RBDMS, it must be a JNDI
name that points to a javax.sql.DataSource object. *This is for a
transactional DataSource*
-{empty} +
-
-
-*javax.jdo.option.ConnectionFactory2Name*
-
-Description
-
-The JNDI name for a connection factory. For RBDMS, it must be a JNDI
+|*javax.jdo.option.ConnectionFactory2Name*
+|The JNDI name for a connection factory. For RBDMS, it must be a JNDI
name that points to a javax.sql.DataSource object. *This is for a
non-transactional DataSource*
-{empty} +
-
-
-*javax.jdo.option.ConnectionDriverName*
-
-Description
-
-The name of the driver to use for the DB
-
-{empty} +
-
-
-*javax.jdo.option.ConnectionDriverURL*
-
-Description
-
-URL specifying the datastore to use for persistence
-
-{empty} +
-
-
-*javax.jdo.option.ConnectionUserName*
-
-Description
+|*javax.jdo.option.ConnectionDriverName*
+|The name of the driver to use for the DB
-Username to use for connecting to the DB
+|*javax.jdo.option.ConnectionDriverURL*
+|URL specifying the datastore to use for persistence
-{empty} +
-
-
-*javax.jdo.option.ConnectionPassword*
-
-Description
-
-Password to use for connecting to the DB
-
-{empty} +
-
-
-*javax.jdo.option.IgnoreCache*
-
-Description
+|*javax.jdo.option.ConnectionUserName*
+|Username to use for connecting to the DB
-Whether to ignore the cache for queries
+|*javax.jdo.option.ConnectionPassword*
+|Password to use for connecting to the DB
-Range of Values
-true | false
-
-{empty} +
-
-
-*javax.jdo.option.Multithreaded*
-
-Description
-
-Whether to run the PersistenceManager multithreaded
-
-Range of Values
-
-true | false
-
-{empty} +
+|*javax.jdo.option.IgnoreCache*
+|Whether to ignore the cache for queries. Range of Values: true \| false
+|*javax.jdo.option.Multithreaded*
+|Whether to run the PersistenceManager multithreaded.
+Range of Values: true \| false
-*javax.jdo.option.NontransactionalRead*
+|*javax.jdo.option.NontransactionalRead*
+|Whether to allow nontransactional reads.
+Range of Values: true \| false
-Description
+|*javax.jdo.option.NontransactionalWrite*
+|Whether to allow nontransactional writes.
+Range of Values: true \| false
-Whether to allow nontransactional reads
-Range of Values
-
-true | false
-
-{empty} +
-
-
-*javax.jdo.option.NontransactionalWrite*
-
-Description
-
-Whether to allow nontransactional writes
-
-Range of Values
-
-true | false
-
-{empty} +
-
-
-*javax.jdo.option.Optimistic*
-
-Description
-
-Whether to use link:transactions.html[Optimistic transactions]
-
-Range of Values
-
-true | false
-
-{empty} +
+|*javax.jdo.option.Optimistic*
+|Whether to use link:transactions.html[Optimistic transactions]. Range of Values: true \| false
-*javax.jdo.option.RetainValues*
+|*javax.jdo.option.RetainValues*
+|Whether to suppress the clearing of values from persistent instances on
+transaction completion. Range of Values: true \| false
-Description
+|*javax.jdo.option.RestoreValues*
-Whether to suppress the clearing of values from persistent instances on
-transaction completion
+|Whether persistent object have transactional field values restored when
+transaction rollback occurs. Range of Values: true \| false
-Range of Values
-
-true | false
-
-{empty} +
-
-
-*javax.jdo.option.RestoreValues*
-
-Description
-
-Whether persistent object have transactional field values restored when
-transaction rollback occurs.
-
-Range of Values
-
-true | false
-
-{empty} +
-
-
-*javax.jdo.option.Mapping*
-
-Description
-
-Name for the ORM MetaData mapping files to use with this PMF. For
+|*javax.jdo.option.Mapping*
+|Name for the ORM MetaData mapping files to use with this PMF. For
example if this is set to "mysql" then the implementation looks for
MetaData mapping files called "\{classname}-mysql.orm" or
"package-mysql.orm". If this is not specified then the JDO
implementation assumes that all is specified in the JDO MetaData file.
_ORM datastores only_
-{empty} +
-
-
-*javax.jdo.mapping.Catalog*
-
-Description
-
-Name of the catalog to use by default for all classes persisted using
+|*javax.jdo.mapping.Catalog*
+|Name of the catalog to use by default for all classes persisted using
this PMF. This can be overridden in the MetaData where required, and is
optional. JPOX will prefix all table names with this catalog name if the
RDBMS supports specification of catalog names in DDL. _ORM datastores
only_
-{empty} +
-
-
-*javax.jdo.mapping.Schema*
-
-Description
-
-Name of the schema to use by default for all classes persisted using
+|*javax.jdo.mapping.Schema*
+|Name of the schema to use by default for all classes persisted using
this PMF. This can be overridden in the MetaData where required, and is
optional. JPOX will prefix all table names with this schema name if the
RDBMS supports specification of schema names in DDL. _ORM datastores
only_
-{empty} +
-
-
-*javax.jdo.option.DetachAllOnCommit*
-
-Description
-
-Allows the user to select that when a transaction is committed all
+|*javax.jdo.option.DetachAllOnCommit*
+|Allows the user to select that when a transaction is committed all
objects enlisted in that transaction will be automatically detached.
+Range of Values: true \| *false*
-Range of Values
-
-true | *false*
-
-{empty} +
-
-
-*javax.jdo.option.CopyOnAttach*
-
-Description
-
-Whether, when attaching a detached object, we create an attached copy or
+|*javax.jdo.option.CopyOnAttach*
+|Whether, when attaching a detached object, we create an attached copy or
simply migrate the detached object to attached state. This is from JDO
-2.1
-
-Range of Values
+2.1. Range of Values: *true* \| false
-*true* | false
-
-{empty} +
-
-
-*javax.jdo.option.TransactionType*
-
-Description
-
-Type of transaction to use. If running under J2SE the default is
+|*javax.jdo.option.TransactionType*
+|Type of transaction to use. If running under J2SE the default is
RESOURCE_LOCAL, and if running under J2EE the default is JTA.
+Range of Values: RESOURCE_LOCAL \| JTA
-Range of Values
-
-RESOURCE_LOCAL | JTA
-
-{empty} +
-
-
-*javax.jdo.option.PersistenceUnitName*
-
-Description
-
-Name of the "persistence-unit" to use with this PMF. This borrows the
+|*javax.jdo.option.PersistenceUnitName*
+|Name of the "persistence-unit" to use with this PMF. This borrows the
"persistence-unit" concept from JPA for use with JDO 2.1.
-{empty} +
-
-
-*javax.jdo.option.ServerTimeZoneID*
-
-Description
-
-Id of the TimeZone under which the datastore server is running. If this
+|*javax.jdo.option.ServerTimeZoneID*
+|Id of the TimeZone under which the datastore server is running. If this
is not specified or is set to null it is assumed that the datastore
server is running in the same timezone as the JVM under which the
implementation is running.
-{empty} +
-
-
-*javax.jdo.option.Name*
-
-Description
-
-Name of the PMF. This is for use with "named PMF" functionality in JDO
+|*javax.jdo.option.Name*
+|Name of the PMF. This is for use with "named PMF" functionality in JDO
2.1
-{empty} +
-
-
-*javax.jdo.option.ReadOnly*
-
-Description
+|*javax.jdo.option.ReadOnly*
+|Whether this datastore should be treated as read only. Added in JDO 2.2
+Range of Values: true \| *false*
-Whether this datastore should be treated as read only. Added in JDO 2.2
+|*javax.jdo.option.TransactionIsolationLevel*
-Range of Values
+|Isolation level to use for connections in the current transaction. Added
+in JDO 2.2. Range of Values: none \| read-committed \| read-uncommitted \|
+repeatable-read \| snapshot \| serializable
-true | *false*
-
-{empty} +
+|===
-*javax.jdo.option.TransactionIsolationLevel*
-
-Description
-
-Isolation level to use for connections in the current transaction. Added
-in JDO 2.2
-
-Range of Values
-
-none | read-committed | read-uncommitted | repeatable-read | snapshot |
-serializable
-
-{empty} +
-
-{empty} +
-
diff --git a/src/main/asciidoc/source-code.adoc b/src/main/asciidoc/source-code.adoc
new file mode 100644
index 0000000..25327b1
--- /dev/null
+++ b/src/main/asciidoc/source-code.adoc
@@ -0,0 +1,41 @@
+:_basedir:
+:_imagesdir: images/
+:grid: cols
+:development:
+
+[[index]]
+
+== JDO Source Codeanchor:JDO_Source_Code[]
+
+=== Source Code Version Controlanchor:Source_Code_Version_Control[]
+
+Apache JDO uses https://git-scm.com[git] to manage its source code.
+
+To receive notice of commits to the repository subscribe to
+jdo-commits@db.apache.org by sending email to jdo-commits-subscribe@db.apache.org.
+
+The ASF operates a dual master system for repositories that use Git as their primary version
+control system. This means committers may commit to either gitbox.apache.org or GitHub.
+
+=== Checking Out Code
+
+You can download the Apache JDO source code using:
+
+....
+git clone https://gitbox.apache.org/repos/asf/db-jdo.git
+git clone https://github.com/apache/db-jdo.git
+....
+
+Contributors can fork this repo using github’s tools and contribute patches/new features using pull requests.
+
+Committers can push to this repo directly, once their ASF account and github account have been linked.
+See https://gitbox.apache.org/setup[gitbox setup] for more details on how to do this.
+
+=== Web Site
+
+The sources for this site are available in a distinct Git repository:
+
+....
+https://gitbox.apache.org/repos/asf/db-jdo-site.git
+https://github.com/apache/db-jdo-site.git
+....
diff --git a/src/main/asciidoc/svn.adoc b/src/main/asciidoc/svn.adoc
deleted file mode 100644
index 6bd3fd9..0000000
--- a/src/main/asciidoc/svn.adoc
+++ /dev/null
@@ -1,238 +0,0 @@
-:_basedir:
-:_imagesdir: images/
-:grid: cols
-:development:
-
-[[index]]
-
-== JDO Source Codeanchor:JDO_Source_Code[]
-
-=== Source Code Version Controlanchor:Source_Code_Version_Control[]
-
-Apache JDO uses http://subversion.tigris.org[Subversion] to manage its
-source code. If you're new to Subversion, you can check out the
-http://svnbook.red-bean.com/[online book] about Subversion. Note that we
-are currently using Subversion 1.1.x (there are separate versions of the
-book covering 1.0 and 1.1).
-
-To receive notice of commits to the repository subscribe to
-jdo-commits@db.apache.org by sending email to
-jdo-commits-subscribe@db.apache.org.
-
-=== Web Access to Subversionanchor:Web_Access_to_Subversion[]
-
-If you just want to browse the source code, you can use the
-https://svn.apache.org/viewvc/db/jdo[ViewVC web interface] to
-Subversion. This is current at all times.
-
-==== Checking Out Code Using Subversionanchor:Checking_Out_Code_Using_Subversion[]
-
-Anyone can check code out of Subversion. You only need to specify a
-username and password to update the Subversion repository, and only JDO
-committers can do that. If you are a committer, are working from behind
-a firewall, or are connected to the internet through a proxy server,
-please see the sections below for more information.
-
-==== Anonymous check out from Subversionanchor:Anonymous_check_out_from_Subversion[]
-
-Use a command like:
-
-....
-% svn checkout http://svn.apache.org/repos/asf/db/jdo
-....
-
-Once you have Apache JDO checked out you can update the source by
-executing the following command from within the jdo.
-
-....
-% svn update
-....
-
-==== Access from behind a firewallanchor:Access_from_behind_a_firewall[]
-
-For those users who are stuck behind a corporate firewall which is
-blocking http access to the Subversion repository, you can try to access
-it via HTTPS:
-
-....
-% svn checkout https://svn.apache.org/repos/asf/db/jdo
-....
-
-==== Access through a proxyanchor:Access_through_a_proxy[]
-
-The Subversion client can go through a proxy, if you configure it to do
-so. First, edit your "servers" configuration file to indicate which
-proxy to use. The files location depends on your operating system. On
-Linux or Unix it is located in the directory "~/.subversion". On Windows
-it is in "%APPDATA%\Subversion". (Try "echo %APPDATA%", note this is a
-hidden directory.)
-
-There are comments in the file explaining what to do. If you don't have
-that file, get the latest Subversion client and run any command; this
-will cause the configuration directory and template files to be created.
-
-Example : Edit the 'servers' file and add something like :
-
-....
-[global]
-http-proxy-host = your.proxy.name
-http-proxy-port = 3128
-....
-
-Please use the regular http proxy settings in case you want to access
-the the repository from the Sun network (SWAN).
-
-==== Committer accessanchor:Committer_access[]
-
-Everyone can access the Apache JDO Subversion repository via HTTPS, but
-Apache JDO Committers must checkout the Subversion repository via HTTPS.
-
-....
-% svn checkout https://svn.apache.org/repos/asf/db/jdo
-....
-
-==== NetBeans CVS repository accessanchor:NetBeans_CVS_repository_access[]
-
-The btree subproject checks out the NetBeans mdr btree implementation.
-This requires cvs being installed on your system. The official NetBeans
-cvs host might not work if you are behind a firewall that blocks the cvs
-port. Please consult the
-http://www.netbeans.org/community/sources[NetBeans sources] page for
-more info.
-
-If you do not have a cvs client installed on your system you can
-download the NetBeans mdr btree sources
-link:/jdo-data/attachments/SubversionRepository/attachments/netbeans-mdr-btree.zip[here].
-Unzip the file in the btree directory and comment out (or remove) the
-definition of the preGoal java:prepare-filesystem.
-
-=== Submitting Code Changesanchor:Submitting_Code_Changes[]
-
-==== Submitting a patchanchor:Submitting_a_patch[]
-
-If you make changes to Apache JDO, and would like to contribute the to
-the project, you should create a patch and send it to the jdo-dev alias
-jdo-dev@db.apache.org. To create a patch, simply execute the following
-command:
-
-....
-% svn diff > your-changes.patch
-....
-
-==== Committing changes to subversionanchor:Committing_changes_to_subversion[]
-
-To commit changes to the Subversion repository, you must be an Apache
-JDO committer. See link:get-involved.html[Get Involved] for information
-on how to become a committer and how to set up your password once you
-become a committer.
-
-Once your password is set, you can use a command like this to commit:
-
-....
-$> svn commit --username your-username
-Authentication realm: <https://svn.apache.org:443> ASF Committers
-Password for 'your-username': your-password
-....
-
-You can also pass your password on the command line directly, but this
-is a security problem on multiuser unix computers (the command line
-arguments are available via the ps command). Here is the command if you
-are Windows or a single user unix computer:
-
-....
-$> svn commit --username your-username --password your-password
-....
-
-Remember to replace 'your-username' and 'your-password' with your actual
-username and password on svn.apache.org.
-
-=== Building JDO from Sourceanchor:Building_JDO_from_Source[]
-
-Refer to the http://wiki.apache.org/jdo/FrontPage[Wiki page] for
-details. Note that the JDO project is subdivided into several smaller
-projects, and each project is built separately.
-
-=== Using Subversion on Windows with cygwinanchor:Using_Subversion_on_Windows_with_cygwin[]
-
-If you use Subversion on Windows under cygwin, you may find that the
-Subversion client automatically assigns the executable property to
-non-executable files. In that case, you would see this at the bottom of
-an _svn diff_ of the file:
-
-....
-Property changes on: test/sql/derby/datastoreidentity/schema1.sql
-___________________________________________________________________
-Name: svn:executable
- + *
-....
-
-This section explains the source of the problem and suggests some
-actions to avoid it.
-
-==== Backgroundanchor:Background[]
-
-Subversion carries executable information in the built-in property
-called svn:executable. This property, unlike others, may be present or
-absent, but it has no value. You can add it or delete it, but but you
-cannot change its value.
-
-In theory, Subversion ignores Windows file permissions and by default
-does not set svn:executable. However, cygwin svn acts like Unix svn and
-determines the svn:executable property based on file permissions.
-
-If you create a file from the cygwin command line, by default it is
-executable only if the filename ends with .bat, .com or .exe, or if its
-content starts with #!. [This is what the doc says, but you may see -x
-for all files.] If you create a file using a Windows tool, by default
-its Windows permissions are executable by all. Cygwin interprets the
-Unix-style permissions this way as well. If the file is executable by
-all, cygwin svn sets the svn:executable property on the file when you
-invoke _svn add_.
-
-==== Removing existing executable properties from the repositoryanchor:Removing_existing_executable_properties_from_the_repository[]
-
-You can use svn propdel to remove the svn:executable property from your
-working copy.
-
-....
- svn propdel -R svn:executable .
-....
-
-will recursively remove the svn:executable property from all of the
-files below the current directory. You can use this and commit the files
-to clean the repository if necessary.
-
-==== Preventing Subversion from adding unwanted executable propertiesanchor:Preventing_Subversion_from_adding_unwanted_executable_properties[]
-
-Windows/cygwin users who don't want to have to think about using _svn
-propdel_ or _chmod_ on each added file can use a non-cygwin version of
-svn. The Subversion 1.2.3 Win32 binaries, downloadable from the link at
-the bottom of http://subversion.tigris.org/project_packages.html, appear
-to work well. After installation add the svn.exe location to your
-Windows PATH variable. If you are switching from cygwin svn to Win32 svn
-
-[arabic]
-. Remove the subversion component from your cygwin installation because
-when svn is invoked from a cygwin window, the cygwin version is found
-even if your cygwin/bin directory is later on the path. (In the Select
-Packages window of the setup wizard, navigate to the subversion package
-in the Devel. category. Click on the status icon until Uninstall is
-displayed. Click next and continue through the wizard until installation
-is complete.)
-. Copy the servers file and the auth folder from the sygwin
-~/.subversion directory to C:\Documents and Settings\<user>\Application
-Data\Subversion used by Win32 subversion.
-
-Note that windows svn uses backslash as the path separator when
-displaying file names. You cannot just copy and paste this file name to
-another svn command when running from within a cygwin shell. You need to
-enclose the file name into double quotes.
-
-Alternatively, Windows users can set file permissions in Windows
-Explorer. (Right-click on the top-level folder & select Properties.
-Select the Security tab. Click Advanced. Remove all instances of Read &
-Execute from the Permission Entries. Click "Reset permissions on all
-child objects and enable propogations of inheritable permissions". Click
-Apply. OK. OK.) You will have to do this again when you do a clean
-checkout to a new directory.
-
diff --git a/src/main/asciidoc/team-list.adoc b/src/main/asciidoc/team-list.adoc
index 9634c75..ff3cded 100644
--- a/src/main/asciidoc/team-list.adoc
+++ b/src/main/asciidoc/team-list.adoc
@@ -19,33 +19,31 @@ have ideas, please feel free to suggest them on the mailing list.
If you would like to become a committer, please see
link:get-involved.html[Get Involved].
-== Apache JDO Committersanchor:Apache_JDO_Committers[]
+=== Apache JDO Committersanchor:Apache_JDO_Committers[]
[cols=",",options="header",]
|===
|Name |Organization
-|Matthew Adams |SpringSource
-|Erik Bengtson |JPOX
-|Michael Bouschen |Tech@Spree
-|Michelle Caisse |Sun Microsystems, Inc.
+|Matthew Adams |Northscaler
+|Erik Bengtson |
+|Michael Bouschen |akquinet tech@spree
+|Michelle Caisse |L-3 Communications
|Andy Jefferson |DataNucleus
-|Patrick Linskey |Oracle
-|Geir Magnusson Jr. |IBM
+|Patrick Linskey |Cisco
+|Geir Magnusson Jr. |fuboTV
|Brian McCallister |
-|Craig Russell |Sun Microsystems, Inc.
+|Craig Russell |
|Dain Sundstrom |
|Brian Topping |
-|Michael Watzek |Tech@Spree
+|Michael Watzek |akquinet tech@spree
|Tilmann Zäschke |http://www.zoodb.org[ZooDB]
-|Martin Zaun |Sun Microsystems, Inc.
+|Martin Zaun |
|===
-== Apache JDO Contributorsanchor:Apache_JDO_Contributors[]
+=== Apache JDO Contributorsanchor:Apache_JDO_Contributors[]
[cols=",",options="header",]
|===
|Name |Organization
-|Chris Beams |SpringSource
-|Ilan Kirsch |ObjectDB
|===
diff --git a/src/main/template/document.html.erb b/src/main/template/document.html.erb
index 3406351..5ad50d7 100644
--- a/src/main/template/document.html.erb
+++ b/src/main/template/document.html.erb
@@ -236,7 +236,7 @@
<ul class="dropdown-menu">
<li><a href="<%= (attr :_basedir) %>roadmap.html">RoadMap / TODO</a></li>
<li><a href="<%= (attr :_basedir) %>downloads.html">Downloads</a></li>
- <li><a href="<%= (attr :_basedir) %>svn.html">Source Code</a></li>
+ <li><a href="<%= (attr :_basedir) %>source-code.html">Source Code</a></li>
<li><a href="<%= (attr :_basedir) %>http://cwiki.apache.org/GMOxDEV/Coding+standards">Coding Standards</a></li>
<li><a href="<%= (attr :_basedir) %>issuetracking.html">Issue Tracking</a></li>
</ul>