[Savannah-cvs] [182] Various doc improvements

[Bob Proulx]

Revision: 182
          
http://svn.sv.gnu.org/viewvc/?view=rev&root=administration&revision=182
Author:   rwp
Date:     2016-04-07 18:12:27 +0000 (Thu, 07 Apr 2016)
Log Message:
-----------
Various doc improvements

See sr#108870.

Ticket Links:
------------
    http://savannah.gnu.org/support/?108870

Modified Paths:
--------------
    trunk/sviki/UsingGit.mdwn

Modified: trunk/sviki/UsingGit.mdwn
===================================================================
--- trunk/sviki/UsingGit.mdwn   2016-04-07 17:40:48 UTC (rev 181)
+++ trunk/sviki/UsingGit.mdwn   2016-04-07 18:12:27 UTC (rev 182)
@@ -8,7 +8,7 @@
 -   **ssh://git.sv.gnu.org/srv/git/myproject.git** - developer access
     using SSH
 -   **http://git.sv.gnu.org/r/myproject.git** - slow dumb protocol,
-    http-based, for use behind fascist firewalls
+    http-based, for use behind excessively restrictive firewalls
 
 Web browser:
 <http://git.sv.gnu.org/gitweb/>
@@ -22,16 +22,20 @@
 Basic commands
 --------------
 
--   Checkout:
+-   Checkout (read-only):
 
         git clone git://git.sv.gnu.org/project.git
 
--   Firewall checkout: if you're behind a outgoing-traffic-filtering
-    firewall, you can use Git's "dumb protocol" via HTTP - note that
-    this is SLOWER, both for you and Savannah. Avoid if possible, and
-    please tell your local sysadmin to allow outgoing git traffic (port
-    9418):
+    For example cloning the GNU Hello project.
 
+        git clone http://git.savannah.gnu.org/hello
+
+-   Firewall checkout (read-only): if you're behind a
+    outgoing-traffic-filtering firewall, you can use Git's "dumb
+    protocol" via HTTP - note that this is SLOWER, both for you and
+    Savannah. Avoid if possible, and please tell your local sysadmin
+    to allow outgoing git traffic (port 9418):
+
         git clone http://git.savannah.gnu.org/r/project.git
 
     Note: we enabled `git-http-backend` (a CGI script) to speed up HTTP
@@ -42,12 +46,21 @@
 
         git clone address@hidden:/srv/git/project.git
 
+    Or using the URL format:
+
+        git clone ssh://address@hidden/srv/git/project.git
+
+Note that the ssh transport requires an active Savannah account and
+you must be a member of at least one project group in order for your
+account to be enabled.
+
 Developer setup
 ---------------
 
 (For git 1.5.1 or newer)
 
-Your identity for when you push commits (strongly recommended):
+Your identity for when you push commits.  (Also okay to use the `GIT_`
+environment variables.)
 
     git config --global user.name "Your Name Comes Here"
     git config --global user.email address@hidden
@@ -62,6 +75,12 @@
 
     git config --global color.ui false
 
+Note: If colors are enabled and you set the `LESS` environment
+variable then it must include the `-R` option or colors will be shown
+as their raw escape sequences.  Warning: Git knows about pagers and
+less and if LESS is not set will set it to `FRSX` but if `LESS` is set
+will not modify it.
+
 Developer basic commands
 ------------------------