From fb3e82af8362660c1403cea1fdfcf1ad0390d50b Mon Sep 17 00:00:00 2001 From: Brian Demers Date: Thu, 17 Mar 2016 00:45:20 +0000 Subject: [PATCH] Replacing svn info with git info git-svn-id: https://svn.apache.org/repos/asf/shiro/site/trunk@1735353 13f79535-47bb-0310-9956-ffa450edef68 --- 2012/01/24/apache-shiro-120-released.html | 2 +- authorization.html | 2 +- developer-resources.html | 16 ++--- download.html | 18 ++--- how-to-contribute.html | 83 ++++++++++++++++++----- java-annotations.html | 2 +- java-authorization-guide.html | 2 +- news.html | 2 +- performing-a-release.html | 10 +-- session-management.html | 4 +- tags.html | 2 +- tutorial.html | 2 +- version-2-brainstorming.html | 2 +- 13 files changed, 99 insertions(+), 48 deletions(-) diff --git a/2012/01/24/apache-shiro-120-released.html b/2012/01/24/apache-shiro-120-released.html index 4c54ee2aa4..cc73fd4e76 100644 --- a/2012/01/24/apache-shiro-120-released.html +++ b/2012/01/24/apache-shiro-120-released.html @@ -26,7 +26,7 @@

There are only a few small cases where breakage could occur - please view the release notes to ensure you mitigate any potential breaking change - particularly if you are using the SecureRandomNumberGenerator
or Shiro's Block Cipher Services (AES, Blowfish):

-

https://svn.apache.org/repos/asf/shiro/tags/shiro-root-1.2.0/RELEASE-NOTES

+

https://raw.githubusercontent.com/apache/shiro/shiro-root-1.2.0/RELEASE-NOTES

Resolved Issues

diff --git a/authorization.html b/authorization.html index 79286d9b77..d5cea21091 100644 --- a/authorization.html +++ b/authorization.html @@ -336,7 +336,7 @@

Configuration

Before you can use Java annotations, you'll need to enable AOP support in your application. There are a number of different AOP frameworks so, unfortunately, there is no standard way to enable AOP in an application.

-

For AspectJ, you can review our AspectJ sample application.

+

For AspectJ, you can review our AspectJ sample application.

For Spring applications, you can look into our Spring Integration documentation.

diff --git a/developer-resources.html b/developer-resources.html index db9dae17b4..a6f3f0c66d 100644 --- a/developer-resources.html +++ b/developer-resources.html @@ -8,29 +8,27 @@

Writing Documentation<

Source Code Repository

-

We use the Subversion repository located at http://svn.apache.org/repos/asf/shiro. Committers must use the https scheme (not http).

+

We use a Git repository located at git://git.apache.org/shiro.git.

-

Active development is done in the trunk subdirectory. The branches and tags peer subdirectories exist based on the Apache APR Versioning Scheme and are generally created/maintained by the dev team using the Maven Release Plugin.

+

Active development is done in the master branch, and maintenance typically on the 1.2.x branch.

-

Building from Subversion

+

Building from Git

-

For Shiro cutting-edge development, you can check-out the code from Subversion and build it using Maven 2.2+:

+

For Shiro cutting-edge development, you can clone the code from Git and build it using Maven 2.2+:

  1. Check out the code: 
    -mkdir shiro
-cd shiro
-svn co https://svn.apache.org/repos/asf/shiro/trunk trunk
+git clone https://github.com/apache/shiro.git
  2. Build the project using Maven 2.2+: 
    -cd trunk
+cd shiro
 mvn install

    The resulting artifacts will be in your local M2 Repo under the org.apache.shiro group.

-
Cutting-edge development
When building from trunk or any branches, use the generated artifacts at your own risk! Current and previous stable releases will always be available via the Download page.
\ No newline at end of file +
Cutting-edge development
When building from master or any branches, use the generated artifacts at your own risk! Current and previous stable releases will always be available via the Download page.
\ No newline at end of file diff --git a/download.html b/download.html index 764f34c40a..55a1f6c90a 100644 --- a/download.html +++ b/download.html @@ -47,7 +47,7 @@

Releases

  • Previous Releases @@ -56,7 +56,7 @@

    Releases

    • @@ -635,13 +635,14 @@

    1.2.4 Source Code Distribution

    href="http://www.apache.org/dyn/closer.cgi/shiro/1.2.4/shiro-root-1.2.4-source-release.zip.sha1">sha1)

    -

    1.2.4 SVN Source repository

    +

    1.2.4 Git Source repository

    -

    The source can be checked out anonymously from SVN with this command:

    +

    The source can be cloned anonymously from Git with this command:

    -svn checkout http://svn.apache.org/repos/asf/shiro/tags/shiro-root-1.2.4
+git clone https://github.com/apache/shiro.git
+git checkout shiro-root-1.2.4 -b shiro-root-1.2.4
    @@ -824,13 +825,14 @@

    1.1.0 Source Code Distribution

    sha1)

    -

    1.1.0 SVN Source repository

    +

    1.1.0 Git Source repository

    -

    The source can be checked out anonymously from SVN with this command:

    +

    The source can be cloned anonymously from Git with this command:

    -svn checkout http://svn.apache.org/repos/asf/shiro/tags/shiro-root-1.1.0
+git clone https://github.com/apache/shiro.git
+git checkout shiro-root-1.1.0 -b shiro-root-1.1.0
    diff --git a/how-to-contribute.html b/how-to-contribute.html index 7e5c61819c..b08a0cd155 100644 --- a/how-to-contribute.html +++ b/how-to-contribute.html @@ -1,6 +1,6 @@

    Contributing to Apache Shiro

    - +

    @@ -33,15 +33,15 @@

    -

    SVN Usage

    +

    +

    Git Usage

    -

    An overview of how to use Subversion (SVN) to participate in Shiro development. Do not be afraid - you cannot accidently destroy the actual code repository, because you are working with a local copy as an anonymous user. Therefore, you do not have the system permissions to change anything. You can only update your local repository and compare your revisions with the real repository. The Download Shiro page explains how to check-out the code base and build your local copy.

    +

    An overview of how to use Git to participate in Shiro development. Do not be afraid - you cannot accidentally destroy the actual code repository, because you are working with a local copy as an anonymous user. Therefore, you do not have the system permissions to change anything. You can only update your local repository and compare your revisions with the real repository. The Download Shiro page explains how to check-out the code base and build your local copy.

    -

    SVN Committers

    +

    Git Committers

    -

    After a developer has consistently provided contributions (code, documentation and discussion) and demonstrated committment, then the rest of the dev community may vote to grant this developer commit access to the Subversion repository. See the ASF developers resources especially the Source code repositories.

    +

    After a developer has consistently provided contributions (code, documentation and discussion) and demonstrated committment, then the rest of the dev community may vote to grant this developer commit access to the Git repository. See the ASF developers resources especially the Source code repositories.

    Procedure for Raising Development Issues

    @@ -59,22 +59,73 @@

    Procedure

    Perhaps you do not get any answer on your first reply, so just post it again until you get one. (But please not every hour - allow a few days for the list to deal with it.) Bear in mind that other countries will have holidays at different times to your country and that they are in different time zones. You might also consider rewriting your initial posting. It may have not been clear to the readers on the mailing list.

    -

    How to prepare and contribute patches

    +

    Contributing as a Non-Committer

    -

    If you use the current development version of Shiro via Subversion, then do 'svn update; svn status' to see what files that you have changed. Do 'svn diff > mypatch.txt' to make a patch which includes every change. To make a patch for a specific file, do svn diff src/documentation/content/xdocs/faq.xml > faq.xml.diff. It is better to prepare the patch from the $SHIRO_HOME directory so that it contains a definite path to the document. However, be careful that the patch does not contain other work-in-progress.

    +

    If you're a committer on an Apache project, it means that you can commit directly to the project's repository. For instance, with Apache Shiro committers are allowed to directly push commits into the git repository.

    -

    For more information about working with SVN, see Version Control with Subversion - the opensource SVN book.

    +

    Non-committers, however, have to submit patches for review. Apache Shiro accepts GitHub pull requests. If you are new to Git and GitHub, check these two links:

    -

    If you use a downloaded released version of Shiro (or don't use SVN), then use the 'diff' command of your operating system: diff -u faq.xml.orig faq.xml > mypatch.txt (better to do that from $SHIRO_HOME directory). If you want to use the most recent version of the documentation then grab its source file directly from the SVN server (and tell us which Revision number you used).

    + -
    Note
    Please send all contributions via our issue tracker. and specify the Forrest version or svn version of the source.
    +

    Apache Shiro has a read-only mirror on GitHub that is kept in sync with the canonical Git repo maintained by the Apache Software Foundation. Submitting GitHub pull requests is the easiest way to get your contribution upstream. For detailed instructions see the link below:

    +GitHub Contribution Guidelines -

    It is always a good idea to check the Shiro issue tracker before diving in.

    +

    Submitting a patch through JIRA

    -

    -

    How to revert changes in SVN

    +

    While we encourage you to submit your contribution through GitHub pull requests, you can also attach a patch in a JIRA ticket. For the purpose of these instructions, we'll assume that you already have a system with Git and have found a bug to fix or have a feature that you'd like to submit, and you're willing to contribute that code or documentation under the Apache License 2.0.

    -

    Check out http://svnbook.red-bean.com/en/1.0/ch04s04.html#svn-ch-4-sect-4.2 for instructions on how to revert (roll back) changes to svn.

    +

    Further, if you're fixing a bug we'll assume that you've either filed a bug report (where you will attach your patch) or are submitting a fix for a known bug. If you find a bug and would like to fix it, that's awesome! Please be sure to file the bug too, though.

    + +

    If you want to add a feature, you should bring it up for discussion on the dev@shiro.apache.org mailing list before implementing it. This ensures that it meshes with the plans that other contributors have for Apache Shiro, and that you're not doing redundant work. Other developers may also have ideas for the feature or suggestions that will help you land the feature without having to re-do the work. More information about our mailing lists can be found here.

    + +

    In short, communication is a vital part of making a contribution to an Apache project.

    + +

    Getting Started

    + +

    First, lets make sure that you've added your name and email to your `~/.gitconfig`:

    + +
    +$ git config --global user.name "Your Name"
+$ git config --global user.email you@domain.com
+
    +You'll grab the Shiro source with git: + +
    +$ git clone https://git-wip-us.apache.org/repos/asf/shiro.git
+
    + +

    If you already have the source, make sure you're working with the most recent version. Do a `git pull` if you cloned the source more than a few hours ago. (Apache Shiro development can move pretty fast!)

    + +
    +$ git checkout -b mybranch
+
    + +

    This does two things: One, it creates the branch mybranch and two, it changes your working branch to mybranch. Running `git branch` will show you which branch you're working on, with an asterisk next to the active branch, like so:

    + +
    +[user@localhost shiro]$ git branch
+master
+* mybranch
+
    + +

    Make whatever changes you're going to make, be sure to use git add to stage the changes, and then you're going to commit the changes to your working branch:

    + +
    +git commit -m "Insert a meaningful summary of changes here."
+
    + +

    Finally, you can create a patch and attach it to the JIRA issue that you created for the bug you are fixing.

    + +
    +git format-patch master --stdout > ~/patch-name.patch
+
    + +

    Review

    + +

    Once you've submitted your pull request, you should receive a response within a few days. If you receive no response within a week, please ping the shiro-dev mailing list (dev@shiro.apache.org).

    Contribution Notes and Tips

    @@ -82,4 +133,4 @@

    Contribution Notes an

    This is a collection of tips for contributing to the project in a manner that is productive for all parties.

    +Whenever you decide to start a new topic, then start with a fresh new email message window. Do not use the "Reply to" button, because threaded mail-readers get confused (they utilise the In-reply-to header). If so, then your new topic will get lost in the previous thread and go unanswered.
  • Prepend your email subject line with a marker when that is appropriate, e.g. [Proposal], [RT] (Random Thought which quickly blossom into research topics , [STATUS] (development status of a certain facility).
  • Remember that most people are participating in development on a volunteer basis and in their "spare time". These enthusiasts will attempt to respond to issues. It may take a little while to get your answers.
  • Research your topic thoroughly before beginning to discuss a new development issue. Search and browse through the email archives - your issue may have been discussed before. Do not just perceive a problem and then rush out with a question - instead, delve.
  • Try to at least offer a partial solution and not just a problem statement.
  • Take the time to clearly explain your issue and write a concise email message. Less confusion facilitates fast and complete resolution.
  • Do not bother to send an email reply that simply says "thanks". When the issue is resolved, that is the finish - end of thread. Reduce clutter.
  • You would usually do any development work against the master branch in Git.
  • When sending a patch, you usually do not need to worry about which Git branch it should be applied to. The maintainers of the repository will decide.
  • Keep all project-related discussion on the mailing list. It is much better to utilise the wider audience, rather than to break off into private discussion groups. You never know who else will have the answer to your issues, and anyway other people are interested in the outcome.
  • Become familiar with the mailing lists. As you browse and search, you will see the way other people do things. Follow the leading examples.
    • diff --git a/java-annotations.html b/java-annotations.html index a04493d58f..670722b979 100644 --- a/java-annotations.html +++ b/java-annotations.html @@ -1,7 +1,7 @@

    Java Annotation Support

    Before you can use Java annotations, you'll need to enable AOP support in your application. There are a number of different AOP frameworks so, unfortunately, there is no standard way to enable AOP in an application.

    -

    For AspectJ, you can review our AspectJ sample application.

    +

    For AspectJ, you can review our AspectJ sample application.

    For Spring, you can look into our Spring Integration documentation.

    diff --git a/java-authorization-guide.html b/java-authorization-guide.html index 92993fa5b9..b84a641ecf 100644 --- a/java-authorization-guide.html +++ b/java-authorization-guide.html @@ -156,7 +156,7 @@

    Annotation Auth

    Enabling Annotation Support

    Before you can use Java annotations, you'll need to enable AOP support in your application. There are a number of different AOP frameworks so, unfortunately, there is no standard way to enable AOP in an application.

    -

    For AspectJ, you can review our AspectJ sample application.

    +

    For AspectJ, you can review our AspectJ sample application.

    For Spring, you can look into our Spring Integration documentation.

    diff --git a/news.html b/news.html index 0ac1cd60e9..4184fb1eb7 100644 --- a/news.html +++ b/news.html @@ -185,7 +185,7 @@

    There are only a few small cases where breakage could occur - please view the release notes to ensure you mitigate any potential breaking change - particularly if you are using the SecureRandomNumberGenerator
    or Shiro's Block Cipher Services (AES, Blowfish):

    -

    https://svn.apache.org/repos/asf/shiro/tags/shiro-root-1.2.0/RELEASE-NOTES

    +

    https://raw.githubusercontent.com/apache/shiro/shiro-root-1.2.0/RELEASE-NOTES

    Resolved Issues

    diff --git a/performing-a-release.html b/performing-a-release.html index d7a0ae06b6..032022d21e 100644 --- a/performing-a-release.html +++ b/performing-a-release.html @@ -15,8 +15,8 @@

    Create the Release > mvn release:prepare -DdryRun=true > mvn deploy -Pdocs > mvn release:clean -> mvn release:prepare -Dusername=YOUR_SVN_USERNAME -Dpassword=YOUR_SVN_PASSWORD -> mvn release:perform -Dusername=YOUR_SVN_USERNAME -Dpassword=YOUR_SVN_PASSWORD +> mvn release:prepare -Dusername=YOUR_ASF_USERNAME -Dpassword=YOUR_ASF_PASSWORD +> mvn release:perform -Dusername=YOUR_ASF_USERNAME -Dpassword=YOUR_ASF_PASSWORD
  • Log in to https://repository.apache.org. Navigate to "Staging Repositories" (on the left nav panel). Find the repository starting with 'org.apache.shiro' and close it.
  • Send out the VOTE email to the dev@shiro.apache.org mailing list. Here's a good template:
    @@ -28,7 +28,7 @@

    Create the Release https://issues.apache.org/jira/secure/IssueNavigator!executeAdvanced.jspa?jqlQuery=project+%3D+SHIRO+AND+fixVersion+%3D+%221.2.0%22+AND+%28status+%21%3D+Open+and+status+%21%3D+%22In+Progress%22%29+ORDER+BY+priority+DESC&runQuery=true&clear=true The tag to be voted upon: -<SVN_URL_OF_THE_RELEASE_TAG> (e.g. https://svn.apache.org/repos/asf/shiro/tags/1.2.0) +<GIT_URL_OF_THE_RELEASE_TAG> (e.g. https://github.com/apache/shiro/tree/1.2.0) Staging repo for binaries: <URL_OF_THE_CLOSED_REPO_FROM_ABOVE_STEP> (e.g. https://repository.apache.org/content/repositories/orgapacheshiro-92/) @@ -52,7 +52,7 @@

    Create the Release

    After a Successful Vote

    -
    1. Update the Shiro DOAP file in subversion to include another release information chunk (after the other similar chunks): +
      1. Update the Shiro DOAP file in git to include another release information chunk (after the other similar chunks): 
         <release>
@@ -65,7 +65,7 @@ 
        After a Successful Vot


        -With the appropriate RELEASE_DATE (e.g. 2011-10-01) and VERSION (e.g. 1.1.0). Save and commit the file to SVN. +With the appropriate RELEASE_DATE (e.g. 2011-10-01) and VERSION (e.g. 1.1.0). Save and commit the file to Git.

      2. Put the distribution on the ASF web servers
        1. SSH into people.apache.org and cd to to Shiro's distribution location: diff --git a/session-management.html b/session-management.html index 09257a6f20..8ba199bec9 100644 --- a/session-management.html +++ b/session-management.html @@ -223,11 +223,11 @@

          EHCache SessionDAO

          EHCache Session Cache Configuration
          -

          By default, the EhCacheManager uses a Shiro-specific ehcache.xml file that sets up the Session cache region and the necessary settings to ensure Sessions are stored and retrieved properly.

          +

          By default, the EhCacheManager uses a Shiro-specific ehcache.xml file that sets up the Session cache region and the necessary settings to ensure Sessions are stored and retrieved properly.

          However, if you wish to change the cache settings, or configure your own ehcache.xml or EHCache net.sf.ehcache.CacheManager instance, you will need to configure the cache region to ensure that Sessions are handled correctly.

          -

          If you look at the default ehcache.xml file, you will see the following shiro-activeSessionCache cache configuration:

          +

          If you look at the default ehcache.xml file, you will see the following shiro-activeSessionCache cache configuration:

          diff --git a/tags.html b/tags.html
index 64ae30a238..24e691a412 100644
--- a/tags.html
+++ b/tags.html
@@ -1,5 +1,5 @@
 
diff --git a/tutorial.html b/tutorial.html
index 08c1ada1cb..de022470e3 100644
--- a/tutorial.html
+++ b/tutorial.html
@@ -26,7 +26,7 @@ 
          Your First Apache Shi
 
          If you're new to Apache Shiro, this short tutorial will show you how to set up an initial and very simple application secured by Apache Shiro.  We'll discuss Shiro's core concepts along the way to help familiarize you with Shiro's design and API.
          
 
 
          If you don't want to actually edit files as you follow this tutorial, you can obtain a nearly identical sample application and reference it as you go.  Choose a location:
          
-
+
 
 
          Setup
          
 
diff --git a/version-2-brainstorming.html b/version-2-brainstorming.html
index 5838903ee0..763b0a4ce0 100644
--- a/version-2-brainstorming.html
+++ b/version-2-brainstorming.html
@@ -106,7 +106,7 @@ 
          Subject Princ
 
 
          Convert this to be a sub-interface of Map with additional per-Realm utility methods.
          
 
-
          See the PrincipalMap concept for ideas (experimental, not referenced in Shiro 1.x at the moment).
          
+
          See the PrincipalMap concept for ideas (experimental, not referenced in Shiro 1.x at the moment).
          
 
 
          Maybe rename this to 'attributes'?  i.e. subject.getAttributes()?