diff options
Diffstat (limited to 'Documentation/gitweb.txt')
| -rw-r--r-- | Documentation/gitweb.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt index 168e8bfed6..cd9c8951b2 100644 --- a/Documentation/gitweb.txt +++ b/Documentation/gitweb.txt @@ -7,14 +7,14 @@ gitweb - Git web interface (web frontend to Git repositories) SYNOPSIS -------- -To get started with gitweb, run linkgit:git-instaweb[1] from a git repository. +To get started with gitweb, run linkgit:git-instaweb[1] from a Git repository. This would configure and start your web server, and run web browser pointing to gitweb. DESCRIPTION ----------- -Gitweb provides a web interface to git repositories. Its features include: +Gitweb provides a web interface to Git repositories. Its features include: * Viewing multiple Git repositories with common root. * Browsing every revision of the repository. @@ -54,9 +54,9 @@ our $projectroot = '/path/to/parent/directory'; The default value for `$projectroot` is '/pub/git'. You can change it during building gitweb via `GITWEB_PROJECTROOT` build configuration variable. -By default all git repositories under `$projectroot` are visible and available +By default all Git repositories under `$projectroot` are visible and available to gitweb. The list of projects is generated by default by scanning the -`$projectroot` directory for git repositories (for object databases to be +`$projectroot` directory for Git repositories (for object databases to be more exact; gitweb is not interested in a working area, and is best suited to showing "bare" repositories). @@ -84,7 +84,7 @@ separator (rules for Perl's "`split(" ", $line)`"). * Fields use modified URI encoding, defined in RFC 3986, section 2.1 (Percent-Encoding), or rather "Query string encoding" (see -link:http://en.wikipedia.org/wiki/Query_string#URL_encoding[]), the difference +http://en.wikipedia.org/wiki/Query_string#URL_encoding[]), the difference being that SP (" ") can be encoded as "{plus}" (and therefore "{plus}" has to be also percent-encoded). + @@ -111,7 +111,7 @@ foo/bar.git O+W+Ner+<owner@example.org> By default this file controls only which projects are *visible* on projects -list page (note that entries that do not point to correctly recognized git +list page (note that entries that do not point to correctly recognized Git repositories won't be displayed by gitweb). Even if a project is not visible on projects list page, you can view it nevertheless by hand-crafting a gitweb URL. By setting `$strict_export` configuration variable (see @@ -151,9 +151,9 @@ as projects list file, which means that you can set `$projects_list` to its filename. -Controlling access to git repositories +Controlling access to Git repositories ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -By default all git repositories under `$projectroot` are visible and +By default all Git repositories under `$projectroot` are visible and available to gitweb. You can however configure how gitweb controls access to repositories. @@ -206,7 +206,7 @@ $export_auth_hook = sub { Per-repository gitweb configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can configure individual repositories shown in gitweb by creating file -in the 'GIT_DIR' of git repository, or by setting some repo configuration +in the 'GIT_DIR' of Git repository, or by setting some repo configuration variable (in 'GIT_DIR/config', see linkgit:git-config[1]). You can use the following files in repository: @@ -504,7 +504,7 @@ repositories, you can configure Apache like this: The above configuration expects your public repositories to live under '/pub/git' and will serve them as `http://git.domain.org/dir-under-pub-git`, -both as cloneable GIT URL and as browseable gitweb interface. If you then +both as clonable Git URL and as browseable gitweb interface. If you then start your linkgit:git-daemon[1] with `--base-path=/pub/git --export-all` then you can even use the `git://` URL with exactly the same path. @@ -584,7 +584,7 @@ $projectroot = $ENV{'GITWEB_PROJECTROOT'} || "/pub/git"; referenced by `$per_request_config`; These configurations enable two things. First, each unix user (`<user>`) of -the server will be able to browse through gitweb git repositories found in +the server will be able to browse through gitweb Git repositories found in '~/public_git/' with the following url: http://git.example.org/~<user>/ @@ -673,7 +673,7 @@ The additional AliasMatch makes it so that http://git.example.com/project.git -will give raw access to the project's git dir (so that the project can be +will give raw access to the project's Git dir (so that the project can be cloned), while http://git.example.com/project |