Use consistent lowercase for "gitweb"

We had inconsistent class and variable naming in Gerrit to the point
that (prior to I640e645f6) there were two completely different classes
named "GitwebConfig" and "GitWebConfig".

In the official upstream Git documentation, this command line tool is
most often referred to as "gitweb". Standardize on this
capitalization in text. It may still be capitalized at the beginning
of sentences, or where required by programming language style (e.g.
Java class names).

The only exceptions are:
 - MSysGit's wiki page is entitled GitWeb, so use that when referring
   specifically to that page.
 - Old release notes were not touched.

Change-Id: I497477c264e9cc1380c520618f8edf13e7226c9d
This commit is contained in:
Dave Borowitz
2015-06-05 15:22:23 -07:00
parent 2615c38377
commit a3d6788212
29 changed files with 153 additions and 155 deletions

View File

@@ -23,14 +23,14 @@ import com.google.gerrit.httpd.auth.become.BecomeAnyAccountModule;
import com.google.gerrit.httpd.auth.container.HttpAuthModule;
import com.google.gerrit.httpd.auth.container.HttpsClientSslCertModule;
import com.google.gerrit.httpd.auth.ldap.LdapAuthModule;
import com.google.gerrit.httpd.gitweb.GitWebModule;
import com.google.gerrit.httpd.gitweb.GitwebModule;
import com.google.gerrit.httpd.rpc.UiRpcModule;
import com.google.gerrit.lifecycle.LifecycleModule;
import com.google.gerrit.server.RemotePeer;
import com.google.gerrit.server.config.AuthConfig;
import com.google.gerrit.server.config.CanonicalWebUrl;
import com.google.gerrit.server.config.GerritRequestModule;
import com.google.gerrit.server.config.GitWebCgiConfig;
import com.google.gerrit.server.config.GitwebCgiConfig;
import com.google.gerrit.server.git.AsyncReceiveCommits;
import com.google.gerrit.server.util.GuiceRequestScopePropagator;
import com.google.gerrit.server.util.RequestScopePropagator;
@@ -43,18 +43,18 @@ import java.net.SocketAddress;
public class WebModule extends LifecycleModule {
private final AuthConfig authConfig;
private final boolean wantSSL;
private final GitWebCgiConfig gitWebCgiConfig;
private final GitwebCgiConfig gitwebCgiConfig;
private final GerritOptions options;
@Inject
WebModule(AuthConfig authConfig,
@CanonicalWebUrl @Nullable String canonicalUrl,
GerritOptions options,
GitWebCgiConfig gitWebCgiConfig) {
GitwebCgiConfig gitwebCgiConfig) {
this.authConfig = authConfig;
this.wantSSL = canonicalUrl != null && canonicalUrl.startsWith("https:");
this.options = options;
this.gitWebCgiConfig = gitWebCgiConfig;
this.gitwebCgiConfig = gitwebCgiConfig;
}
@Override
@@ -75,8 +75,8 @@ public class WebModule extends LifecycleModule {
install(new GerritRequestModule());
install(new GitOverHttpServlet.Module(options.enableMasterFeatures()));
if (gitWebCgiConfig.getGitwebCgi() != null) {
install(new GitWebModule());
if (gitwebCgiConfig.getGitwebCgi() != null) {
install(new GitwebModule());
}
DynamicSet.setOf(binder(), WebUiPlugin.class);

View File

@@ -17,7 +17,7 @@ package com.google.gerrit.httpd.gitweb;
import static com.google.gerrit.common.FileUtil.lastModified;
import com.google.common.io.ByteStreams;
import com.google.gerrit.server.config.GitWebCgiConfig;
import com.google.gerrit.server.config.GitwebCgiConfig;
import com.google.gwtexpui.server.CacheHeaders;
import com.google.inject.Inject;
import com.google.inject.Singleton;
@@ -41,7 +41,7 @@ class GitLogoServlet extends HttpServlet {
private final byte[] raw;
@Inject
GitLogoServlet(GitWebCgiConfig cfg) throws IOException {
GitLogoServlet(GitwebCgiConfig cfg) throws IOException {
byte[] png;
Path src = cfg.getGitLogoPng();
if (src != null) {

View File

@@ -17,7 +17,7 @@ package com.google.gerrit.httpd.gitweb;
import static com.google.gerrit.common.FileUtil.lastModified;
import com.google.gerrit.httpd.HtmlDomUtil;
import com.google.gerrit.server.config.GitWebCgiConfig;
import com.google.gerrit.server.config.GitwebCgiConfig;
import com.google.gerrit.server.config.SitePaths;
import com.google.gwtexpui.server.CacheHeaders;
import com.google.gwtjsonrpc.server.RPCServletUtils;
@@ -34,9 +34,9 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@SuppressWarnings("serial")
abstract class GitWebCssServlet extends HttpServlet {
abstract class GitwebCssServlet extends HttpServlet {
@Singleton
static class Site extends GitWebCssServlet {
static class Site extends GitwebCssServlet {
@Inject
Site(SitePaths paths) throws IOException {
super(paths.site_css);
@@ -44,9 +44,9 @@ abstract class GitWebCssServlet extends HttpServlet {
}
@Singleton
static class Default extends GitWebCssServlet {
static class Default extends GitwebCssServlet {
@Inject
Default(GitWebCgiConfig gwcc) throws IOException {
Default(GitwebCgiConfig gwcc) throws IOException {
super(gwcc.getGitwebCss());
}
}
@@ -57,7 +57,7 @@ abstract class GitWebCssServlet extends HttpServlet {
private final byte[] raw_css;
private final byte[] gz_css;
GitWebCssServlet(final Path src)
GitwebCssServlet(final Path src)
throws IOException {
if (src != null) {
final Path dir = src.getParent();

View File

@@ -17,7 +17,7 @@ package com.google.gerrit.httpd.gitweb;
import static com.google.gerrit.common.FileUtil.lastModified;
import com.google.common.io.ByteStreams;
import com.google.gerrit.server.config.GitWebCgiConfig;
import com.google.gerrit.server.config.GitwebCgiConfig;
import com.google.gwtexpui.server.CacheHeaders;
import com.google.inject.Inject;
import com.google.inject.Singleton;
@@ -36,14 +36,14 @@ import javax.servlet.http.HttpServletResponse;
@SuppressWarnings("serial")
@Singleton
class GitWebJavaScriptServlet extends HttpServlet {
class GitwebJavaScriptServlet extends HttpServlet {
private final long modified;
private final byte[] raw;
@Inject
GitWebJavaScriptServlet(GitWebCgiConfig gitWebCgiConfig) throws IOException {
GitwebJavaScriptServlet(GitwebCgiConfig gitwebCgiConfig) throws IOException {
byte[] png;
Path src = gitWebCgiConfig.getGitwebJs();
Path src = gitwebCgiConfig.getGitwebJs();
if (src != null) {
try (InputStream in = Files.newInputStream(src)) {
png = ByteStreams.toByteArray(in);

View File

@@ -16,13 +16,13 @@ package com.google.gerrit.httpd.gitweb;
import com.google.inject.servlet.ServletModule;
public class GitWebModule extends ServletModule {
public class GitwebModule extends ServletModule {
@Override
protected void configureServlets() {
serve("/gitweb").with(GitWebServlet.class);
serve("/gitweb").with(GitwebServlet.class);
serve("/gitweb-logo.png").with(GitLogoServlet.class);
serve("/gitweb.js").with(GitWebJavaScriptServlet.class);
serve("/gitweb-default.css").with(GitWebCssServlet.Default.class);
serve("/gitweb-site.css").with(GitWebCssServlet.Site.class);
serve("/gitweb.js").with(GitwebJavaScriptServlet.class);
serve("/gitweb-default.css").with(GitwebCssServlet.Default.class);
serve("/gitweb-site.css").with(GitwebCssServlet.Site.class);
}
}

View File

@@ -38,8 +38,8 @@ import com.google.gerrit.server.AnonymousUser;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.IdentifiedUser;
import com.google.gerrit.server.config.GerritServerConfig;
import com.google.gerrit.server.config.GitWebCgiConfig;
import com.google.gerrit.server.config.GitWebConfig;
import com.google.gerrit.server.config.GitwebCgiConfig;
import com.google.gerrit.server.config.GitwebConfig;
import com.google.gerrit.server.config.SitePaths;
import com.google.gerrit.server.git.LocalDiskRepositoryManager;
import com.google.gerrit.server.project.NoSuchProjectException;
@@ -82,9 +82,9 @@ import javax.servlet.http.HttpServletResponse;
/** Invokes {@code gitweb.cgi} for the project given in {@code p}. */
@SuppressWarnings("serial")
@Singleton
class GitWebServlet extends HttpServlet {
class GitwebServlet extends HttpServlet {
private static final Logger log =
LoggerFactory.getLogger(GitWebServlet.class);
LoggerFactory.getLogger(GitwebServlet.class);
private static final String PROJECT_LIST_ACTION = "project_list";
@@ -99,24 +99,24 @@ class GitWebServlet extends HttpServlet {
private final EnvList _env;
@Inject
GitWebServlet(LocalDiskRepositoryManager repoManager,
GitwebServlet(LocalDiskRepositoryManager repoManager,
ProjectControl.Factory projectControl,
Provider<AnonymousUser> anonymousUserProvider,
Provider<CurrentUser> userProvider,
SitePaths site,
@GerritServerConfig Config cfg,
SshInfo sshInfo,
GitWebConfig gitWebConfig,
GitWebCgiConfig gitWebCgiConfig)
GitwebConfig gitwebConfig,
GitwebCgiConfig gitwebCgiConfig)
throws IOException {
this.repoManager = repoManager;
this.projectControl = projectControl;
this.anonymousUserProvider = anonymousUserProvider;
this.userProvider = userProvider;
this.gitwebCgi = gitWebCgiConfig.getGitwebCgi();
this.gitwebCgi = gitwebCgiConfig.getGitwebCgi();
this.deniedActions = new HashSet<>();
final String url = gitWebConfig.getUrl();
final String url = gitwebConfig.getUrl();
if ((url != null) && (!url.equals("gitweb"))) {
URI uri = null;
try {
@@ -269,7 +269,7 @@ class GitWebServlet extends HttpServlet {
}
// Link back to Gerrit (when possible, to matching review record).
// Supported Gitweb's hash values are:
// Supported gitweb's hash values are:
// - (missing),
// - HEAD,
// - refs/heads/<branch>,
@@ -579,7 +579,7 @@ class GitWebServlet extends HttpServlet {
env.set("REMOTE_USER", remoteUser);
// Override CGI settings using alternative URI provided by gitweb.url.
// This is required to trick Gitweb into thinking that it's served under
// This is required to trick gitweb into thinking that it's served under
// different URL. Setting just $my_uri on the perl's side isn't enough,
// because few actions (atom, blobdiff_plain, commitdiff_plain) rely on
// URL returned by $cgi->self_url().
@@ -644,7 +644,7 @@ class GitWebServlet extends HttpServlet {
log.debug("Unexpected error copying input to CGI", e);
}
}
}, "GitWeb-InputFeeder").start();
}, "Gitweb-InputFeeder").start();
}
private void copyStderrToLog(final InputStream in) {
@@ -666,7 +666,7 @@ class GitWebServlet extends HttpServlet {
log.debug("Unexpected error copying stderr from CGI", e);
}
}
}, "GitWeb-ErrorLogger").start();
}, "Gitweb-ErrorLogger").start();
}
private static Enumeration<String> enumerateHeaderNames(HttpServletRequest req) {