dizzyd avatar dizzyd committed 68da746

Fix minor typo and ensure wrap at 80 cols

Comments (0)

Files changed (4)

-                                       Welcome to Riak.
-                                       ================
+                                Welcome to Riak.
+                                ================
 
 
 
 2 Quick Start 
 ~~~~~~~~~~~~~~
 
-  This section assumes that you have copy of the Riak source tree. To get started, you need to:
+  This section assumes that you have copy of the Riak source tree. To get
+  started, you need to:
   1. Build Riak
   2. Start the Riak server
   3. Connect a client and store/fetch data
 2.2 Starting Riak 
 ==================
 
-   Once you have successfully built Riak, you can start the server with the following commands:
+   Once you have successfully built Riak, you can start the server with the
+   following commands:
 
    $ cd $RIAK/rel/riak
    $ bin/riak start
 
    $ bin/riak-admin test
 
-   Note that the $RIAK/rel/riak directory is a complete, self-contained instance of Riak and
-   Erlang. It is strongly suggested that you move this directory outside the source tree if you
-   plan to run a production instance.
+   Note that the $RIAK/rel/riak directory is a complete, self-contained instance
+   of Riak and Erlang. It is strongly suggested that you move this directory
+   outside the source tree if you plan to run a production instance.
 
 2.3 Connecting a client to Riak 
 ================================
 
-   Now that you have a functional server, let's try storing some data in it. First,
-   start up a erlang node using our embedded version of erlang:
+   Now that you have a functional server, let's try storing some data in
+   it. First, start up a erlang node using our embedded version of erlang:
 
    $ erts-<vsn>/bin/erl -name riaktest -setcookie riak
    
 
 3.1 Configuration 
 ==================
-   Configuration for the Riak server is stored in $RIAK/rel/riak/etc directory. There are two
-   files:
-   - vm.args     
-     This file contains the arguments that are passed to the Erlang VM in which Riak runs. The default
-     settings in this file shouldn't need to be changed for most environments.
+   Configuration for the Riak server is stored in $RIAK/rel/riak/etc
+   directory. There are two files:
+   - vm.args 
+     This file contains the arguments that are passed to the Erlang VM
+     in which Riak runs. The default settings in this file shouldn't need to be
+     changed for most environments.
 
-   - app.config
-     This file contains the configuration for the Erlang applications that run on the Riak server. 
+   - app.config 
+     This file contains the configuration for the Erlang applications
+     that run on the Riak server.
 
 3.2 Server Control 
 ===================
 
 3.2.1 bin/riak 
 ---------------
-    This script is the primary interface for starting and stopping the Riak server. 
+    This script is the primary interface for starting and stopping the Riak
+    server.
 
     To start a daemonized (background) instance of Riak:
 
     $ bin/riak start 
 
-    Once a server is running in the background you can attach to the Erlang console via:
+    Once a server is running in the background you can attach to the Erlang
+    console via:
 
     $ bin/riak attach
 
-    Alternatively, if you want to run a foreground instance of Riak, start it with:
+    Alternatively, if you want to run a foreground instance of Riak, start it
+    with:
 
     $ bin/riak console
 
-    Stopping a foreground or background instance of Riak can be done from a shell prompt via:
+    Stopping a foreground or background instance of Riak can be done from a
+    shell prompt via:
 
     $ bin/riak stop 
 
 
 * Quick Start
 
-  This section assumes that you have copy of the Riak source tree. To get started, you need to:
+  This section assumes that you have copy of the Riak source tree. To get
+  started, you need to:
   1. Build Riak
   2. Start the Riak server
   3. Connect a client and store/fetch data
 
 ** Starting Riak
 
-   Once you have successfully built Riak, you can start the server with the following commands:
+   Once you have successfully built Riak, you can start the server with the
+   following commands:
 
    $ cd $RIAK/rel/riak
    $ bin/riak start
 
    $ bin/riak-admin test
 
-   Note that the $RIAK/rel/riak directory is a complete, self-contained instance of Riak and
-   Erlang. It is strongly suggested that you move this directory outside the source tree if you
-   plan to run a production instance.
+   Note that the $RIAK/rel/riak directory is a complete, self-contained instance
+   of Riak and Erlang. It is strongly suggested that you move this directory
+   outside the source tree if you plan to run a production instance.
 
 ** Connecting a client to Riak
 
-   Now that you have a functional server, let's try storing some data in it. First,
-   start up a erlang node using our embedded version of erlang:
+   Now that you have a functional server, let's try storing some data in
+   it. First, start up a erlang node using our embedded version of erlang:
 
    $ erts-<vsn>/bin/erl -name riaktest -setcookie riak
    
 * Server Management
 
 ** Configuration
-   Configuration for the Riak server is stored in $RIAK/rel/riak/etc directory. There are two
-   files:
-   - vm.args     
-     This file contains the arguments that are passed to the Erlang VM in which Riak runs. The default
-     settings in this file shouldn't need to be changed for most environments.
+   Configuration for the Riak server is stored in $RIAK/rel/riak/etc
+   directory. There are two files:
+   - vm.args 
+     This file contains the arguments that are passed to the Erlang VM
+     in which Riak runs. The default settings in this file shouldn't need to be
+     changed for most environments.
 
-   - app.config
-     This file contains the configuration for the Erlang applications that run on the Riak server. 
+   - app.config 
+     This file contains the configuration for the Erlang applications
+     that run on the Riak server.
 
 ** Server Control
 *** bin/riak
-    This script is the primary interface for starting and stopping the Riak server. 
+    This script is the primary interface for starting and stopping the Riak
+    server.
 
     To start a daemonized (background) instance of Riak:
 
     $ bin/riak start 
 
-    Once a server is running in the background you can attach to the Erlang console via:
+    Once a server is running in the background you can attach to the Erlang
+    console via:
 
     $ bin/riak attach
 
-    Alternatively, if you want to run a foreground instance of Riak, start it with:
+    Alternatively, if you want to run a foreground instance of Riak, start it
+    with:
 
     $ bin/riak console
 
-    Stopping a foreground or background instance of Riak can be done from a shell prompt via:
+    Stopping a foreground or background instance of Riak can be done from a
+    shell prompt via:
 
     $ bin/riak stop 
 
-                            Notes on Riak Source Tree Restructuring
-                            =======================================
+                    Notes on Riak Source Tree Restructuring
+                    =======================================
 
 
 
 
 1 Overview 
 ~~~~~~~~~~~
-  The Riak source tree has undergone a major restructuring as part of a transition to a new
-  build tool -- rebar. This tool enforces OTP compliant directory structures for the riak
-  application and its dependencies and provides an easy-to-use wrapper around the new reltool
-  system available in Erlang R1303+. Using reltool makes it possible to construct a standalone
-  server instance that can used on machines without Erlang installed. This transition has also
-  enabled us to introduce a standardized script for starting/stopping and other server
-  management tasks.
+  The Riak source tree has undergone a major restructuring as part of a
+  transition to a new build tool -- rebar. This tool enforces OTP compliant
+  directory structures for the riak application and its dependencies and
+  provides an easy-to-use wrapper around the new reltool system available in
+  Erlang R1303+. Using reltool makes it possible to construct a standalone
+  server instance that can be used on machines without Erlang installed. This
+  transition has also enabled us to introduce a standardized script for
+  starting/stopping and other server management tasks.
 
 
 2 Summary of changes 
 
 2.1 Building 
 =============
-   The source code can still be compiled using a single invocation of make at the top-level
-   $RIAK directory:
+   The source code can still be compiled using a single invocation of make at
+   the top-level $RIAK directory:
 
    $ make
 
-   However, if you want a runnable, redistributable server you need to make sure the "rel"
-   target gets built:
+   However, if you want a runnable, redistributable server you need to make sure
+   the "rel" target gets built:
 
    $ make rel
 
-   This will place a full server install in the $RIAK/rel/riak directory. You can safely copy
-   this riak directory to any other machine with the SAME operating system and architecture and
-   run riak.  See the README for more information about how to start/stop the server.
+   This will place a full server install in the $RIAK/rel/riak directory. You
+   can safely copy this riak directory to any other machine with the SAME
+   operating system and architecture and run riak.  See the README for more
+   information about how to start/stop the server.
 
-   As an alternative to the "rel" target, if you are doing active development on the Riak
-   source code you may want to try the "devrel" target. This will generate three runnable nodes
-   in $RIAK/dev and symlink them in such a way that recompiles of the Riak source code
-   (i.e. simple invocation of "make") is automatically available to those nodes. These three nodes,
-   (dev1, dev2, dev2) are NOT suitable for redistribution. They simply make it easy to quickly test
+   As an alternative to the "rel" target, if you are doing active development on
+   the Riak source code you may want to try the "devrel" target. This will
+   generate three runnable nodes in $RIAK/dev and symlink them in such a way
+   that recompiles of the Riak source code (i.e. simple invocation of "make") is
+   automatically available to those nodes. These three nodes, (dev1, dev2, dev2)
+   are NOT suitable for redistribution. They simply make it easy to quickly test
    changes to the Riak source code in a development environment.
 
 2.2 Server scripts 
 ===================
-   start-*.sh and debug-*.sh have all been replaced with the bin/riak and bin/riak-admin scripts
-   that are generated as part of the "rel" or "devrel" targets.
+   start-*.sh and debug-*.sh have all been replaced with the bin/riak and
+   bin/riak-admin scripts that are generated as part of the "rel" or "devrel"
+   targets.
 
 2.2.1 riak_demo.escript 
 ------------------------
 
 2.2.2 start-backup/restore/logger.sh 
 -------------------------------------
-    The functionality of these scripts is now available via the bin/riak-admin script.
+    The functionality of these scripts is now available via the bin/riak-admin
+    script.
 
 2.3 Configuration 
 ==================
-   The config/ directory has been removed; you can now find default configuration in $RIAK/rel/overlay/etc
-   directory -- the app.config and vm.args files are copied from that location when running the "rel" or
-   "devrel" targets. If you already have run the release targets you can just edit the files in the
-   $RIAK/rel/riak/etc or $RIAK/dev/dev*/etc directories respectively.
+   The config/ directory has been removed; you can now find default
+   configuration in $RIAK/rel/overlay/etc directory -- the app.config and
+   vm.args files are copied from that location when running the "rel" or
+   "devrel" targets. If you already have run the release targets you can just
+   edit the files in the $RIAK/rel/riak/etc or $RIAK/dev/dev*/etc directories
+   respectively.
 
 2.3.1 riak-env.sh 
 ------------------
 Notes on Riak Source Tree Restructuring
 
 * Overview
-  The Riak source tree has undergone a major restructuring as part of a transition to a new
-  build tool -- rebar. This tool enforces OTP compliant directory structures for the riak
-  application and its dependencies and provides an easy-to-use wrapper around the new reltool
-  system available in Erlang R1303+. Using reltool makes it possible to construct a standalone
-  server instance that can used on machines without Erlang installed. This transition has also
-  enabled us to introduce a standardized script for starting/stopping and other server
-  management tasks.
+  The Riak source tree has undergone a major restructuring as part of a
+  transition to a new build tool -- rebar. This tool enforces OTP compliant
+  directory structures for the riak application and its dependencies and
+  provides an easy-to-use wrapper around the new reltool system available in
+  Erlang R1303+. Using reltool makes it possible to construct a standalone
+  server instance that can be used on machines without Erlang installed. This
+  transition has also enabled us to introduce a standardized script for
+  starting/stopping and other server management tasks.
 
 
 * Summary of changes
 
 ** Building
-   The source code can still be compiled using a single invocation of make at the top-level
-   $RIAK directory:
+   The source code can still be compiled using a single invocation of make at
+   the top-level $RIAK directory:
 
    $ make
 
-   However, if you want a runnable, redistributable server you need to make sure the "rel"
-   target gets built:
+   However, if you want a runnable, redistributable server you need to make sure
+   the "rel" target gets built:
 
    $ make rel
 
-   This will place a full server install in the $RIAK/rel/riak directory. You can safely copy
-   this riak directory to any other machine with the SAME operating system and architecture and
-   run riak.  See the README for more information about how to start/stop the server.
+   This will place a full server install in the $RIAK/rel/riak directory. You
+   can safely copy this riak directory to any other machine with the SAME
+   operating system and architecture and run riak.  See the README for more
+   information about how to start/stop the server.
 
-   As an alternative to the "rel" target, if you are doing active development on the Riak
-   source code you may want to try the "devrel" target. This will generate three runnable nodes
-   in $RIAK/dev and symlink them in such a way that recompiles of the Riak source code
-   (i.e. simple invocation of "make") is automatically available to those nodes. These three nodes,
-   (dev1, dev2, dev2) are NOT suitable for redistribution. They simply make it easy to quickly test
+   As an alternative to the "rel" target, if you are doing active development on
+   the Riak source code you may want to try the "devrel" target. This will
+   generate three runnable nodes in $RIAK/dev and symlink them in such a way
+   that recompiles of the Riak source code (i.e. simple invocation of "make") is
+   automatically available to those nodes. These three nodes, (dev1, dev2, dev2)
+   are NOT suitable for redistribution. They simply make it easy to quickly test
    changes to the Riak source code in a development environment.
 
 ** Server scripts
-   start-*.sh and debug-*.sh have all been replaced with the bin/riak and bin/riak-admin scripts
-   that are generated as part of the "rel" or "devrel" targets.
+   start-*.sh and debug-*.sh have all been replaced with the bin/riak and
+   bin/riak-admin scripts that are generated as part of the "rel" or "devrel"
+   targets.
 
 *** riak_demo.escript 
     The functionality of this script is now available via:
 
 
 *** start-backup/restore/logger.sh
-    The functionality of these scripts is now available via the bin/riak-admin script.
+    The functionality of these scripts is now available via the bin/riak-admin
+    script.
 
 ** Configuration
-   The config/ directory has been removed; you can now find default configuration in $RIAK/rel/overlay/etc
-   directory -- the app.config and vm.args files are copied from that location when running the "rel" or
-   "devrel" targets. If you already have run the release targets you can just edit the files in the
-   $RIAK/rel/riak/etc or $RIAK/dev/dev*/etc directories respectively.
+   The config/ directory has been removed; you can now find default
+   configuration in $RIAK/rel/overlay/etc directory -- the app.config and
+   vm.args files are copied from that location when running the "rel" or
+   "devrel" targets. If you already have run the release targets you can just
+   edit the files in the $RIAK/rel/riak/etc or $RIAK/dev/dev*/etc directories
+   respectively.
 
 *** riak-env.sh
     This file has been replaced with vm.args. 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.