Spelling fixes in the gitweb documentation
Mostly spelling and grammar nits. Signed-off-by: Rafael Garcia-Suarez <rgarciasuarez@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Rafael Garcia-Suarez committed
Apr 17, 2008 at 13:45 UTC
eae7a75904f9634736ff622be9d1c1e5f5567c27
2 files changed
+65
-64
gitweb/INSTALL
+40
-39
@@ -29,40 +29,40 @@ Build time configuration
29
See also "How to configure gitweb for your local system" in README
30
file for gitweb (in gitweb/README).
31
32
-- There are many configuration variables which affects building of
32
+- There are many configuration variables which affect building of
33
gitweb.cgi; see "default configuration for gitweb" section in main
34
(top dir) Makefile, and instructions for building gitweb/gitweb.cgi
35
target.
36
37
- One of most important is where to find git wrapper binary. Gitweb
38
- tries to find git wrapper at $(bindir)/git, so you have to set $bindir
37
+ One of the most important is where to find the git wrapper binary. Gitweb
38
+ tries to find the git wrapper at $(bindir)/git, so you have to set $bindir
39
when building gitweb.cgi, or $prefix from which $bindir is derived. If
40
- you build and install gitweb together with the rest of git suite,
40
+ you build and install gitweb together with the rest of the git suite,
41
there should be no problems. Otherwise, if git was for example
42
installed from a binary package, you have to set $prefix (or $bindir)
43
accordingly.
44
45
- Another important issue is where are git repositories you want to make
46
- available to gitweb. By default gitweb search for repositories under
46
+ available to gitweb. By default gitweb searches for repositories under
47
/pub/git; if you want to have projects somewhere else, like /home/git,
48
use GITWEB_PROJECTROOT build configuration variable.
49
50
By default all git repositories under projectroot are visible and
51
- available to gitweb. List of projects is generated by default by
51
+ available to gitweb. The list of projects is generated by default by
52
scanning the projectroot directory for git repositories. This can be
53
changed (configured) as described in "Gitweb repositories" section
54
below.
55
56
- Note that gitweb deals directly with object database, and does not
57
- need working directory; the name of the project is the name of its
56
+ Note that gitweb deals directly with the object database, and does not
57
+ need a working directory; the name of the project is the name of its
58
repository object database, usually projectname.git for bare
59
repositories. If you want to provide gitweb access to non-bare (live)
60
- repository, you can make projectname.git symbolic link under
60
+ repositories, you can make projectname.git a symbolic link under
61
projectroot linking to projectname/.git (but it is just
62
a suggestion).
63
64
- You can control where gitweb tries to find its main CSS style file,
65
- its favicon and logo with GITWEB_CSS, GITWEB_FAVICON and GITWEB_LOGO
65
+ its favicon and logo with the GITWEB_CSS, GITWEB_FAVICON and GITWEB_LOGO
66
build configuration variables. By default gitweb tries to find them
67
in the same directory as gitweb.cgi script.
68
@@ -91,17 +91,17 @@ Gitweb config file
91
See also "Runtime gitweb configuration" section in README file
92
for gitweb (in gitweb/README).
93
94
-- You can configure gitweb further using gitweb configuration file;
95
- by default it is file named gitweb_config.perl in the same place as
96
- gitweb.cgi script. You can control default place for config file
97
- using GITWEB_CONFIG build configuration variable, and you can set it
98
- using GITWEB_CONFIG environmental variable. If this file does not
94
+- You can configure gitweb further using the gitweb configuration file;
95
+ by default this is a file named gitweb_config.perl in the same place as
96
+ gitweb.cgi script. You can control the default place for the config file
97
+ using the GITWEB_CONFIG build configuration variable, and you can set it
98
+ using the GITWEB_CONFIG environment variable. If this file does not
99
exist, gitweb looks for a system-wide configuration file, normally
100
/etc/gitweb.conf. You can change the default using the
101
GITWEB_CONFIG_SYSTEM build configuration variable, and override it
102
- through GITWEB_CONFIG_SYSTEM environmental variable.
102
+ through the GITWEB_CONFIG_SYSTEM environment variable.
103
104
-- Gitweb config file is [fragment] of perl code. You can set variables
104
+- The gitweb config file is a fragment of perl code. You can set variables
105
using "our $variable = value"; text from "#" character until the end
106
of a line is ignored. See perlsyn(1) for details.
107
@@ -128,36 +128,37 @@ Gitweb repositories
128
-------------------
129
130
- By default all git repositories under projectroot are visible and
131
- available to gitweb. List of projects is generated by default by
131
+ available to gitweb. The list of projects is generated by default by
132
scanning the projectroot directory for git repositories (for object
133
databases to be more exact).
134
135
- You can provide pre-generated list of [visible] repositories,
135
+ You can provide a pre-generated list of [visible] repositories,
136
together with information about their owners (the project ownership
137
- is taken from owner of repository directory otherwise), by setting
138
- GITWEB_LIST build configuration variable (or $projects_list variable
139
- in gitweb config file) to point to a plain file.
140
-
141
- Each line of projects list file should consist of url-encoded path
142
- to project repository database (relative to projectroot) separated
143
- by space from url-encoded project owner; spaces in both project path
144
- and project owner have to be encoded as either '%20' or '+'.
145
-
146
- You can generate projects list index file using project_index action
147
- (the 'TXT' link on projects list page) directly from gitweb.
148
-
149
-- By default even if project is not visible on projects list page, you
150
- can view it nevertheless by hand-crafting gitweb URL. You can set
151
- GITWEB_STRICT_EXPORT build configuration variable (or $strict_export
152
- variable in gitweb config file) to only allow viewing of
137
+ defaults to the owner of the repository directory otherwise), by setting
138
+ the GITWEB_LIST build configuration variable (or the $projects_list
139
+ variable in the gitweb config file) to point to a plain file.
140
+
141
+ Each line of the projects list file should consist of the url-encoded path
142
+ to the project repository database (relative to projectroot), followed
143
+ by the url-encoded project owner on the same line (separated by a space).
144
+ Spaces in both project path and project owner have to be encoded as either
145
+ '%20' or '+'.
146
+
147
+ You can generate the projects list index file using the project_index
148
+ action (the 'TXT' link on projects list page) directly from gitweb.
149
+
150
+- By default, even if a project is not visible on projects list page, you
151
+ can view it nevertheless by hand-crafting a gitweb URL. You can set the
152
+ GITWEB_STRICT_EXPORT build configuration variable (or the $strict_export
153
+ variable in the gitweb config file) to only allow viewing of
154
repositories also shown on the overview page.
155
156
- Alternatively, you can configure gitweb to only list and allow
156
- viewing of the explicitly exported repositories, via
157
- GITWEB_EXPORT_OK build configuration variable (or $export_ok
157
+ viewing of the explicitly exported repositories, via the
158
+ GITWEB_EXPORT_OK build configuration variable (or the $export_ok
159
variable in gitweb config file). If it evaluates to true, gitweb
159
- show repository only if this file exists in its object database
160
- (if directory has the magic file $export_ok).
160
+ shows repositories only if this file exists in its object database
161
+ (if directory has the magic file named $export_ok).
162
163
Generating projects list using gitweb
164
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
gitweb/README
+25
-25
@@ -2,7 +2,7 @@ GIT web Interface
2
=================
3
4
The one working on:
5
- http://www.kernel.org/git/
5
+ http://git.kernel.org/
6
7
From the git version 1.4.0 gitweb is bundled with git.
8
@@ -10,13 +10,13 @@ From the git version 1.4.0 gitweb is bundled with git.
10
How to configure gitweb for your local system
11
---------------------------------------------
12
13
-See also "Build time configuration" section in INSTALL
13
+See also the "Build time configuration" section in the INSTALL
14
file for gitweb (in gitweb/INSTALL).
15
16
You can specify the following configuration variables when building GIT:
17
* GIT_BINDIR
18
- Points out where to find git executable. You should set up it to
19
- the place where git binary was installed (usually /usr/bin) if you
18
+ Points where to find the git executable. You should set it up to
19
+ the place where the git binary was installed (usually /usr/bin) if you
20
don't install git from sources together with gitweb. [Default: $(bindir)]
21
* GITWEB_SITENAME
22
Shown in the title of all generated pages, defaults to the server name
@@ -24,13 +24,13 @@ You can specify the following configuration variables when building GIT:
24
* GITWEB_PROJECTROOT
25
The root directory for all projects shown by gitweb. Must be set
26
correctly for gitweb to find repositories to display. See also
27
- "Gitweb repositories" in INSTALL file for gitweb. [Default: /pub/git]
27
+ "Gitweb repositories" in the INSTALL file for gitweb. [Default: /pub/git]
28
* GITWEB_PROJECT_MAXDEPTH
29
- The filesystem traversing limit for getting projects list; the number
29
+ The filesystem traversing limit for getting the project list; the number
30
is taken as depth relative to the projectroot. It is used when
31
GITWEB_LIST is a directory (or is not set; then project root is used).
32
Is is meant to speed up project listing on large work trees by limiting
33
- find depth. [Default: 2007]
33
+ search depth. [Default: 2007]
34
* GITWEB_LIST
35
Points to a directory to scan for projects (defaults to project root
36
if not set / if empty) or to a file with explicit listing of projects
@@ -72,15 +72,15 @@ You can specify the following configuration variables when building GIT:
72
Git base URLs used for URL to where fetch project from, i.e. full
73
URL is "$git_base_url/$project". Shown on projects summary page.
74
Repository URL for project can be also configured per repository; this
75
- takes precendence over URL composed from base URL and project name.
75
+ takes precedence over URLs composed from base URL and a project name.
76
Note that you can setup multiple base URLs (for example one for
77
- git:// protocol access, one for http:// access) from gitweb config
78
- file. [No default]
77
+ git:// protocol access, another for http:// access) from the gitweb
78
+ config file. [No default]
79
* GITWEB_CSS
80
Points to the location where you put gitweb.css on your web server
81
- (or to be more generic URI of gitweb stylesheet). Relative to base
82
- URI of gitweb. Note that you can setup multiple stylesheets from
83
- gitweb config file. [Default: gitweb.css]
81
+ (or to be more generic, the URI of gitweb stylesheet). Relative to the
82
+ base URI of gitweb. Note that you can setup multiple stylesheets from
83
+ the gitweb config file. [Default: gitweb.css]
84
* GITWEB_LOGO
85
Points to the location where you put git-logo.png on your web server
86
(or to be more generic URI of logo, 72x27 size, displayed in top right
@@ -121,15 +121,15 @@ Ultimate description on how to reconfigure the default features setting
121
in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found
122
as comments inside 'gitweb.cgi'.
123
124
-See also "Gitweb config file" (with example of gitweb config file), and
125
-"Gitweb repositories" sections in INSTALL file for gitweb.
124
+See also the "Gitweb config file" (with an example of config file), and
125
+the "Gitweb repositories" sections in INSTALL file for gitweb.
126
127
128
-Gitweb config file is [fragment] of perl code. You can set variables
128
+The gitweb config file is a fragment of perl code. You can set variables
129
using "our $variable = value"; text from "#" character until the end
130
of a line is ignored. See perlsyn(1) man page for details.
131
132
-Below there is list of vaiables which you might want to set in gitweb config.
132
+Below is the list of variables which you might want to set in gitweb config.
133
See the top of 'gitweb.cgi' for the full list of variables and their
134
descriptions.
135
@@ -140,7 +140,7 @@ You can set, among others, the following variables in gitweb config files
140
(with the exception of $projectroot and $projects_list this list does
141
not include variables usually directly set during build):
142
* $GIT
143
- Cure git executable to use. By default set to "$GIT_BINDIR/git", which
143
+ Core git executable to use. By default set to "$GIT_BINDIR/git", which
144
in turn is by default set to "$(bindir)/git". If you use git from binary
145
package, set this to "/usr/bin/git". This can just be "git" if your
146
webserver has a sensible PATH. If you have multiple git versions
@@ -176,7 +176,7 @@ not include variables usually directly set during build):
176
to make it easier to upgrade gitweb. You can add 'site' stylesheet
177
for example by using
178
push @stylesheets, "gitweb-site.css";
179
- in gitweb config file.
179
+ in the gitweb config file.
180
* $logo_url, $logo_label
181
URI and label (title) of GIT logo link (or your site logo, if you choose
182
to use different logo image). By default they point to git homepage;
@@ -198,12 +198,12 @@ not include variables usually directly set during build):
198
Default mimetype for blob_plain (raw) view, if mimetype checking
199
doesn't result in some other type; by default 'text/plain'.
200
* $default_text_plain_charset
201
- Default charset for text files. If not set, web serwer configuration
201
+ Default charset for text files. If not set, web server configuration
202
would be used.
203
* $mimetypes_file
204
File to use for (filename extension based) guessing of MIME types before
205
- trying /etc/mime.types. Path, if relative, is taken currently as taken
206
- relative to current git repositoy.
205
+ trying /etc/mime.types. Path, if relative, is taken currently as
206
+ relative to the current git repository.
207
* $fallback_encoding
208
Gitweb assumes this charset if line contains non-UTF-8 characters.
209
Fallback decoding is used without error checking, so it can be even
@@ -232,14 +232,14 @@ You can use the following files in repository:
232
single line description of a project (of a repository). Plain text file;
233
HTML will be escaped. By default set to
234
Unnamed repository; edit this file to name it for gitweb.
235
- from the template during creating repository. You can use
235
+ from the template during repository creation. You can use the
236
gitweb.description repo configuration variable, but the file takes
237
- precendence.
237
+ precedence.
238
* cloneurl (or multiple-valued gitweb.url)
239
File with repository URL (used for clone and fetch), one per line.
240
Displayed in the project summary page. You can use multiple-valued
241
gitweb.url repository configuration variable for that, but the file
242
- takes precendence.
242
+ takes precedence.
243
* gitweb.owner
244
You can use the gitweb.owner repository configuration variable to set
245
repository's owner. It is displayed in the project list and summary