Skip to site navigation (Press enter)

[CONF] OpenJPA > Source Code

confluence Wed, 11 Aug 2010 07:46:23 -0700

     Source Code
    Page edited by             Donald Woods
    
        
        Comment:
        moved Building and Coding Standards links to this page

    
        

                         Changes (21)
                                 
    

            
            {excerpt:hidden=true}Source code access{excerpt} 
 

            h1. Overview 

            h1. Source Code 

             

            OpenJPA uses [Subversion|http://subversion.tigris.org/] [Subversion|http://subversion.apache.org/] to manage its source code. Instructions on Subversion use can be found [here|http://svnbook.red-bean.com]. 

             

            h1. Main repository 

            h3. Web Access 

             

            h2. Web Access 
 

            The source code for OpenJPA can be freely browsed at [http://svn.apache.org/viewvc/openjpa/]. The source code can also be searched and browsed using Cenqua's FishEye product at [http://fisheye6.cenqua.com/browse/openjpa]. 
 

            h23. Anonymous access 

             
OpenJPA source can be checked out anonymously with this command: 

            ...

             
 

            Once you have OpenJPA checked out you can update the source by executing the following command from within the *openjpa* directory. 

            h3. Developer Access 

             

            {noformat} 
$> svn update 
{noformat} 

            Everyone can access the OpenJPA Subversion repository via HTTPS, but OpenJPA Committers must checkout the Subversion repository via HTTPS in order to make updates, which will prompt for your ASF uid/pwd. 

             

            Once you've got the code you'll probably want to build it; for instructions see [Building OpenJPA|Building]. 
 
h2. 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: 
 

            {noformat} 
$> svn checkout https://svn.apache.org/repos/asf/openjpa/trunk openjpa 

            ...

             
 

            h1. Access through a proxy 

            h1. Compiling Source 

             

            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.) 

            Once you've got the code you'll probably want to build it; for instructions see [Building]. 

             

            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 : 

            h1. Source Coding Standards 

             

            {noformat} 
[global] 
http-proxy-host = your.proxy.name 
http-proxy-port = 3128 
{noformat} 
 
 
h1. Developer Access 
 
Everyone can access the OpenJPA Subversion repository via HTTPS, but OpenJPA Committers must checkout the Subversion repository via HTTPS. 
 
{noformat} 
$> svn checkout https://svn.apache.org/repos/asf/openjpa/trunk openjpa 
{noformat} 
 
 
To commit changes to the repository, you must set your password on the Apache Subversion server. To set your password, use ssh to connect to svn.apache.org, and enter the command *svnpasswd*. This will prompt you to enter a svn password of your choice (pick a safe password). Now, now your are ready to commit changes using your username/password. Execute the following command to commit your changes (svn will prompt you for your password) 
 
{noformat} 
$> svn commit --username your-username 
Authentication realm: <https://svn.apache.org:443> ASF Committers 
Password for 'your-username': your-password 
{noformat} 
 
 
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: 
 
{noformat} 
$> svn commit --username your-username --password your-password 
{noformat} 
 
 
Remember to replace 'your-username' and 'your-password' with your actual username and password on svn.apache.org. 

            The community has agreed upon some common code formatting standards, which we request that everyone follows when contributing patches and checking in changes to the svn repository.  Some of these are enforced during the build, like 120 character line length by using the Checkstyle plugin and checking for required ASL 2.0 source headers by using the apache-rat plugin.  Please checkout the [Coding Standards] page for more details. 

        
                            Full Content
                    
        

Source Code

OpenJPA uses Subversion to manage its source code. Instructions on Subversion use can be found here.

Web Access

The source code for OpenJPA can be freely browsed at http://svn.apache.org/viewvc/openjpa/. The source code can also be searched and browsed using Cenqua's FishEye product at http://fisheye6.cenqua.com/browse/openjpa.

Anonymous access

OpenJPA source can be checked out anonymously with this command:


$> svn checkout http://svn.apache.org/repos/asf/openjpa/trunk openjpa



Developer Access

Everyone can access the OpenJPA Subversion repository via HTTPS, but OpenJPA Committers must checkout the Subversion repository via HTTPS in order to make updates, which will prompt for your ASF uid/pwd.


$> svn checkout https://svn.apache.org/repos/asf/openjpa/trunk openjpa




Compiling Source

Once you've got the code you'll probably want to build it; for instructions see Building.


Source Coding Standards

The community has agreed upon some common code formatting standards, which we request that everyone follows when contributing patches and checking in changes to the svn repository.  Some of these are enforced during the build, like 120 character line length by using the Checkstyle plugin and checking for required ASL 2.0 source headers by using the apache-rat plugin.  Please checkout the Coding Standards page for more details.

    
        
        
            Change Notification Preferences
        
        View Online
        |
        View Changes
                |
        Add Comment
 {excerpt:hidden=true}Source code access{excerpt}
-h1. Overview
+h1. Source Code
 OpenJPA uses [Subversion|http://subversion.tigris.org/] [Subversion|http://subversion.apache.org/] to manage its source code. Instructions on Subversion use can be found [here|http://svnbook.red-bean.com].
-h1. Main repository
+h3. Web Access
-h2. Web Access
 The source code for OpenJPA can be freely browsed at [http://svn.apache.org/viewvc/openjpa/]. The source code can also be searched and browsed using Cenqua's FishEye product at [http://fisheye6.cenqua.com/browse/openjpa].
 h23. Anonymous access
 OpenJPA source can be checked out anonymously with this command:
 ...
-Once you have OpenJPA checked out you can update the source by executing the following command from within the *openjpa* directory.
+h3. Developer Access
-{noformat} 
$> svn update 
{noformat}
+Everyone can access the OpenJPA Subversion repository via HTTPS, but OpenJPA Committers must checkout the Subversion repository via HTTPS in order to make updates, which will prompt for your ASF uid/pwd.
-Once you've got the code you'll probably want to build it; for instructions see [Building OpenJPA|Building]. 
 
h2. 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:
 {noformat} 
$> svn checkout https://svn.apache.org/repos/asf/openjpa/trunk openjpa
 ...
-h1. Access through a proxy
+h1. Compiling Source
-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.)
+Once you've got the code you'll probably want to build it; for instructions see [Building].
-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 :
+h1. Source Coding Standards
-{noformat} 
[global] 
http-proxy-host = your.proxy.name 
http-proxy-port = 3128 
{noformat} 
 
 
h1. Developer Access 
 
Everyone can access the OpenJPA Subversion repository via HTTPS, but OpenJPA Committers must checkout the Subversion repository via HTTPS. 
 
{noformat} 
$> svn checkout https://svn.apache.org/repos/asf/openjpa/trunk openjpa 
{noformat} 
 
 
To commit changes to the repository, you must set your password on the Apache Subversion server. To set your password, use ssh to connect to svn.apache.org, and enter the command *svnpasswd*. This will prompt you to enter a svn password of your choice (pick a safe password). Now, now your are ready to commit changes using your username/password. Execute the following command to commit your changes (svn will prompt you for your password) 
 
{noformat} 
$> svn commit --username your-username 
Authentication realm: <https://svn.apache.org:443> ASF Committers 
Password for 'your-username': your-password 
{noformat} 
 
 
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: 
 
{noformat} 
$> svn commit --username your-username --password your-password 
{noformat} 
 
 
Remember to replace 'your-username' and 'your-password' with your actual username and password on svn.apache.org.
+The community has agreed upon some common code formatting standards, which we request that everyone follows when contributing patches and checking in changes to the svn repository.  Some of these are enforced during the build, like 120 character line length by using the Checkstyle plugin and checking for required ASL 2.0 source headers by using the apache-rat plugin.  Please checkout the [Coding Standards] page for more details.