diff options
author | Shawn O. Pearce <sop@google.com> | 2009-05-08 18:31:51 -0700 |
---|---|---|
committer | Shawn O. Pearce <sop@google.com> | 2009-05-08 18:32:12 -0700 |
commit | 1261bef926902d6818cc56db988df4b0e3857450 (patch) | |
tree | 17517d08aa931234f521e46800c6b7f56e5ba039 | |
parent | 7b40571a496356ebf645948b9da52c374f78f7b3 (diff) |
Cleanup formatting references for file system path variables
We now more consistently format these in italics.
Signed-off-by: Shawn O. Pearce <sop@google.com>
-rw-r--r-- | Documentation/config-gerrit.txt | 2 | ||||
-rw-r--r-- | Documentation/config-gitweb.txt | 4 | ||||
-rw-r--r-- | Documentation/config-headerfooter.txt | 14 | ||||
-rw-r--r-- | Documentation/config-replication.txt | 2 | ||||
-rw-r--r-- | Documentation/dev-design.txt | 2 | ||||
-rw-r--r-- | Documentation/project-setup.txt | 4 |
6 files changed, 14 insertions, 14 deletions
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt index 4c319a0327..97dc1c16ab 100644 --- a/Documentation/config-gerrit.txt +++ b/Documentation/config-gerrit.txt @@ -120,7 +120,7 @@ contributor agreement before they can upload changes. + If enabled, the admin must also insert one or more rows into `contributor_agreements` and create agreement files under -`$site_path/static`, so users can actually complete one or +`'$site_path'/static`, so users can actually complete one or more agreements. + By default this is `N` (no agreements are used). diff --git a/Documentation/config-gitweb.txt b/Documentation/config-gitweb.txt index 36cacec6d2..74f774bddf 100644 --- a/Documentation/config-gitweb.txt +++ b/Documentation/config-gitweb.txt @@ -7,7 +7,7 @@ from Gerrit content to the same information, but shown by gitweb. To enable the gitweb integration, update `system_config.gitweb_url` with the URL of your gitweb CGI. -The CGI's `$projectroot` should be `git_base_path`, or a fairly +The CGI's `$projectroot` should be `'$git_base_path'`, or a fairly current replica. If a replica is being used, ensure it uses a full mirror, so the `refs/changes/*` namespace is available. @@ -28,7 +28,7 @@ gitweb_url ~~~~~~~~~~ Defines the web location where a `gitweb.cgi` is installed to browse -`git_base_path` and the repositories it contains. +`'$git_base_path'` and the repositories it contains. Gerrit appends any necessary query arguments onto the end of this URL. For example, "?p=$project.git;h=$commit". diff --git a/Documentation/config-headerfooter.txt b/Documentation/config-headerfooter.txt index 61d05810d9..b5297ad3e7 100644 --- a/Documentation/config-headerfooter.txt +++ b/Documentation/config-headerfooter.txt @@ -11,19 +11,19 @@ HTML Header/Footer At startup Gerrit reads the following files (if they exist) and uses them to customize the HTML page it sends to clients: -* `$site_path/GerritSiteHeader.html` +* `'$site_path'/GerritSiteHeader.html` + HTML is inserted below the menu bar, but above any page content. This is a good location for an organizational logo, or links to other systems like bug tracking. -* `$site_path/GerritSiteFooter.html` +* `'$site_path'/GerritSiteFooter.html` + HTML is inserted at the bottom of the page, below all other content, but just above the footer rule and the "Powered by Gerrit Code Review (v....)" message shown at the extreme bottom. -* `$site_path/GerritSite.css` +* `'$site_path'/GerritSite.css` + The CSS rules are inlined into the top of the HTML page, inside of a `<style>` tag. These rules can be used to support styling @@ -40,13 +40,13 @@ more than one root level element, Gerrit will not start. Static Images ------------- -Static image files can also be served from `$site_path/static`, +Static image files can also be served from `'$site_path'/static`, and may be referenced in `GerritSite{Header,Footer}.html` or `GerritSite.css` by the relative URL `static/$name` (e.g. `static/logo.png`). To simplify security management, only files are served from -`$site_path/static`. Subdirectories are explicitly forbidden from +`'$site_path'/static`. Subdirectories are explicitly forbidden from being served from this location by enforcing the rule that file names cannot contain `/` or `\`. (Client requests for `static/foo/bar` will result in 404 Not Found responses.) @@ -58,7 +58,7 @@ The header, footer, and CSS files are inlined into the host page, which is always sent with a no-cache header. Clients will see any changes immediately after the Gerrit server has been restarted. -Assets under `$site_path/static` whose file name matches one of the +Assets under `'$site_path'/static` whose file name matches one of the following patterns are served with a 1 year expiration, permitting very aggressive caching by clients and edge-proxies: @@ -69,7 +69,7 @@ very aggressive caching by clients and edge-proxies: * `*.cache.jar` * `*.cache.swf` -All other assets under `$site_path/static` are served with a 5 +All other assets under `'$site_path'/static` are served with a 5 minute expire, permitting some (limited) caching. It may take up to 5 minutes after Gerrit restart before clients see the changes. diff --git a/Documentation/config-replication.txt b/Documentation/config-replication.txt index ceee0c176f..544d0cb8fb 100644 --- a/Documentation/config-replication.txt +++ b/Documentation/config-replication.txt @@ -11,7 +11,7 @@ public/private key pair. On a trusted network it is also possible to use replication over the insecure (but much faster) git:// protocol, by enabling the `receive-pack` service on the receiving system. -To enable push replication, create `$\{site_path\}/replication.config` +To enable push replication, create `'$site_path'/replication.config` as a Git-style config file, then restart Gerrit. Currently the replication runs on a 15 second delay. This gives diff --git a/Documentation/dev-design.txt b/Documentation/dev-design.txt index 3dc7d5a7aa..e7f5594bc1 100644 --- a/Documentation/dev-design.txt +++ b/Documentation/dev-design.txt @@ -600,7 +600,7 @@ the warm-standby is reasonably current should the master go offline. Gerrit can be configured to replicate changes made to the local Git repositories over any standard Git transports. This can be -configured in `'site_path'/replication.conf` to send copies of +configured in `'$site_path'/replication.conf` to send copies of all changes over SSH to other servers, or to the Amazon S3 blob storage service. diff --git a/Documentation/project-setup.txt b/Documentation/project-setup.txt index 56b25a5a2d..5a69d24a81 100644 --- a/Documentation/project-setup.txt +++ b/Documentation/project-setup.txt @@ -1,14 +1,14 @@ Gerrit2 - Project Configuration =============================== -All Git repositories under `git_base_path` must be registered in +All Git repositories under `'$git_base_path'` must be registered in the Gerrit database in order to be accessed through SSH, or through the web interface. Create Git Repository --------------------- -Create a Git repository under `git_base_path`: +Create a Git repository under `'$git_base_path'`: ==== git --git-dir=$git_base_path/new/project.git init |