svn commit: r1436439 - /sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext

[ie...@apache.org]

Author: ieb
Date: Mon Jan 21 16:06:06 2013
New Revision: 1436439

URL: http://svn.apache.org/viewvc?rev=1436439&view=rev
Log:
Fixed some formatting issues, mainly surrounding links.

Modified:
    sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext

Modified: sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext?rev=1436439&r1=1436438&r2=1436439&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext (original)
+++ sling/site/trunk/content/documentation/development/getting-and-building-sling.mdtext Mon Jan 21 16:06:06 2013
@@ -4,6 +4,7 @@ Excerpt: A quick guide for getting the S
 A quick guide for getting the Sling source, then building and running the resulting Sling instance; either without or with Eclipse.
 
 Sling can easily be built:
+
 * from the command line (using SVN and the Maven command line tool)
 * or using Eclipse
 
@@ -14,13 +15,15 @@ A full build of Sling takes 5-10 minutes
 ## Prerequisites
 
 Before you begin, you need to have the following tools installed on your system:
-* Java 5 or higher; Java 6 recommended
-* [Maven]({{ refs.http://maven.apache.org.path }}) 3.0.2 or later; enforced by the Sling parent pom
+
+* Java 6 or higher; Java 6 recommended
+* [Maven](http://maven.apache.org) 3.0.2 or later; enforced by the Sling parent pom
 
 If you want to set up Eclipse (not required to build Sling) you'll also need the following installed:
+
 * Eclipse (tested with 3.4.2 and 3.5.x on Win XP, SP3, 3.6.x on Win7, 3.7 on MacOS X 10.6); just a plain installation of the platform runtime binary and the JDT will be adequate (you can install the IDE for Java Developers for convenience) 
-* M2Eclipse plugin for Eclipse (sonatype) \-> [instructions]({{ refs.http://m2eclipse.sonatype.org/installing-m2eclipse.html.path }})
-* [Subversive plugin]({{ refs.http://www.polarion.com/products/svn/subversive.php.path }}) or [Subclipse-plugin|http://subclipse.tigris.org] for Eclipse
+* M2Eclipse plugin for Eclipse (sonatype) \-> [instructions](http://m2eclipse.sonatype.org/installing-m2eclipse.html)
+* [Subversive plugin](http://www.polarion.com/products/svn/subversive.php) or [Subclipse-plugin](http://subclipse.tigris.org) for Eclipse
 
 ## Environment Setup
 
@@ -43,7 +46,7 @@ For 64bit platforms, you should use
     MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=512m"
 
 
-For more information see [SLING-443]({{ refs.https://issues.apache.org/jira/browse/SLING-443.path }}) and [SLING-1782|https://issues.apache.org/jira/browse/SLING-1782].
+For more information see [SLING-443](https://issues.apache.org/jira/browse/SLING-443) and [SLING-1782](https://issues.apache.org/jira/browse/SLING-1782).
 
 
 ### Environment Variable Space
@@ -55,6 +58,7 @@ For more information see [SLING-443]({{ 
     error=12, Not enough space
 
 This problem is caused by insufficient swap space. When running the integration tests in the `launchpad/testing` modules, a process is launched by calling the `exec` system call. This copies the process (copy-on-write, though) and thus allocates as much virtual memory as is owned by the parent process. This may fail if swap space is exhausted.
+
 * *Platform* \- OpenSolaris
 * *Fix* \- If this issue persists you will need to check your system requirements and configuration with regard to swap, before taking action - if necessary.
 
@@ -83,13 +87,15 @@ Also, make sure that you have installed 
 #### Create a new workspace
 
 It's best to create a new workspace for the sling project:
-1. Menu: File->Switch Workspace->Other...
-1. Enter a path for the new workspace and click OK
-1. When Eclipse has restarted it's time to adjust some configs
-1. Turn off automatic build (Menu: Project->Build Automatically)
-1. Go to menu: Eclipse->Preferences, in the preferences dialog select Java \-> Compiler \-> Errors/Warnings
-1. Expand the "Deprecated and restricted API" and change "Forbidden references (access rules)" from "Error" to "Warning"
-1. Click OK
+
+ 1. List item
+ 1. Menu: File->Switch Workspace->Other...
+ 1. Enter a path for the new workspace and click OK
+ 1. When Eclipse has restarted it's time to adjust some configs
+ 1. Turn off automatic build (Menu: Project->Build Automatically)
+ 1. Go to menu: Eclipse->Preferences, in the preferences dialog select Java \-> Compiler \-> Errors/Warnings
+ 1. Expand the "Deprecated and restricted API" and change "Forbidden references (access rules)" from "Error" to "Warning"
+ 1. Click OK
 
 #### Checkout the Sling source
 
@@ -102,6 +108,7 @@ It's best to create a new workspace for 
 Eclipse will now start to download the source and import the Maven projects. You might encounter some "Problem Occured" dialogs about "An internal error...", but just click OK on those and let Eclipse continue with the import. Be warned: This could take some time (it was 30 minutes on my laptop)\!
 
 Possibly something in sling-builder might get a bit messed up (I didn't experience that problem, but Pontus reported it) then you can simply fix it with revert:
+
 1. In the Project Explorer right-click on the "sling-builder" project and select the Team->Revert... menu
 1. A couple of changes will be displayed
 1. Click OK
@@ -118,19 +125,25 @@ Possibly something in sling-builder migh
     $ mvn -s /dev/null clean install
 
 Note: On windows just leave out `/dev/null` and make sure you have an empty settings.xml file for maven (located in your user directory under .m2).
+
 1. Enter the `launchpad/builder` directory and launch Sling for the first time
 
     $ cd launchpad/builder
     $ java -jar target/org.apache.sling.launchpad-*-standalone.jar -c test -f -
 
 
-{note}
+<div class="note">
 When starting Sling inside the `launchpad/builder` folder you should not use the default Sling Home folder name `sling` because this folder is removed when running `mvn clean`.
-{note}
+</div>
+
+Messages should now be printed to the console which is being used as the "log file";
+ 
+* the `-f` command line option is set to `-`, indicating the use of standard output as the log file. 
+* the `-c sling` command line option instructs Sling to use the `sling` directory in the current directory for its data store, which is the Apache Felix bundle archive, the Jackrabbit repository data and configuration. You may also specify another directory here, either a relative or absolute path name (See also [Configuration]({{ refs.configuration.path }}) for more information). 
+* Use the `-h` option to see the list of flags and options.
+
+After all messages have been printed you should be able to open the Sling Management Console by pointing your web browser at [http://localhost:8080/system/console](http://localhost:8080/system/console). You will be prompted for a user name and password. Enter `admin` for both the user name and the password (this may be set on the *Configuration* page later). From this console, you can manage the installed bundles, modify configuration objects, dump a configuration status and see some system information.
 
-Messages should now be printed to the console which is being used as the "log file"; the `\-f` command line option is set to `\-`, indicating the use of standard output as the log file. The `\-c sling` command line option instructs Sling to use the `sling` directory in the current directory for its data store, which is the Apache Felix bundle archive, the Jackrabbit repository data and configuration. You may also specify another directory here, either a relative or absolute path name (See also [Configuration]({{ refs.configuration.path }}) for more information). 
-Use the `-h` option to see the list of flags and options.
-After all messages have been printed you should be able to open the Sling Management Console by pointing your web browser at `[http://localhost:8080/system/console]({{ refs.http://localhost:8080/system/console.path }})`. You will be prompted for a user name and password. Enter `admin` for both the user name and the password (this may be set on the *Configuration* page later). From this console, you can manage the installed bundles, modify configuration objects, dump a configuration status and see some system information.
 To stop Sling, just hit `Ctrl-C` in the console or click the *Stop* button on the *System Information* page of the Sling Management Console.
 
 ### With M2Eclipse
@@ -149,6 +162,7 @@ To stop Sling, just hit `Ctrl-C` in the 
 ### Alternative setup in Eclipse without M2Eclipse plugin
 
 In the case that you do not want to use the M2Eclipse plugin there's another setup that lets you have the automatic build turned on:
+
 1. Checkout the whole sling trunk (with subversive or the subclipse plugin) from SVN to a single project
 1. Then manually add all `src/main/java` and `src/test/java` of the bundles to the project as source folders
 1. Add all required libraries to the build path
@@ -190,12 +204,13 @@ In the same way as you can debug the sli
 
 
 The tests will automatically pause and await a remote debugger on port 5005. You can then attach to the running tests using Eclipse. You can setup a "Remote Java Application" launch configuration via the menu command "Run" > "Open Debug Dialog..." (see above).
-For more information on this see the [Maven Surefire Docu]({{ refs.http://maven.apache.org/plugins/maven-surefire-plugin/examples/debugging.html.path }}).
+For more information on this see the [Maven Surefire Docu](http://maven.apache.org/plugins/maven-surefire-plugin/examples/debugging.html).
 
 
 ### Simple way to develop new bundle in Eclipse for Sling
 
 The easiest way that I found is to create a new folder in the existing Eclipse workspace. After that you can follow these steps:
+
 * Start by copying and adapting an existing Sling pom.xml (eg. the pom.xml from the espblog sample)
 * Generate the Eclipse project files using mvn eclipse:eclipse
 * Choose File/Import in Eclipse and select "Existing projects into workspace"