Overview

Important:
  • Gitweb is neither developed nor owned by WebPros International, LLC, so no support for the tool itself comes from them. Consult the Git Gitweb documentation for details.
  • What Gitweb shows in many of its reports depends on how your repository is built and organized. Because of that, you may find screens in Gitweb that this article does not describe. If you spot something missing here, submit a feature request.

Gitweb is a simple web interface for exploring your repositories. It lets you read file contents and examine logs, commits, and more. To open Gitweb for a repository, press History beside that repository in the cPanel Git™ Version Control interface (cPanel » Home » Files » Git™ Version Control).

The Gitweb interface

When it opens, Gitweb shows the summary report of the project.

  • The breadcrumb trail at the top gives the repository path you are in and the name of the current report. Select a directory name to see Git information for that directory.
    • The cPanel Git™ Version Control (cPanel » Home » Files » Git™ Version Control) feature places a number of restrictions on repository paths.
    • Some lists in Gitweb may also include repositories in your cPanel account that cPanel does not manage.
    • Trying to view repositories that sit in restricted directories can produce errors.
  • Small icons across the interface mark which branches have a given commit as their HEAD commit:
    • Green marks a local branch, grey marks a remote branch, and yellow marks a Git tag. A green master icon (The Gitweb master icon.), for example, shows the HEAD commit of the local master branch.
    • Select the name inside a green or yellow icon to see information for that branch instead of the current one.
  • Some reports have Atom and RSS icons in the lower-right corner, which give you feeds of the repository's activity.
  • Some reports also have TXT and OPML icons in the lower-right corner, which return the data as plain text and as XML respectively.
Note:

Git commands are covered in the Guide to Git™ - Common Git Commands.

Gitweb reports

Repository data in Gitweb is split into reports. Links to the other reports appear at the top of the page and within the report text itself.

blob

Select blob to open the binary large object (blob) of one file. Git keeps the content of a file, as it was at a particular commit, in a blob. The report contains:

  • The commit name that holds the file. If you arrived through the commitdiff report, it shows the SHA-1 identifier of that file version instead.
  • The file's path inside the repository.
    • Select a directory name to open the tree report of that directory
    • Select the file name or raw to get the file as plain text.
  • The file content, numbered by line. Select a line number to jump straight to it.
Note:

Select HEAD to see the blob report of the file as it is in the HEAD commit.

Linked reports

commit

Select commit to see everything recorded for a single commit. Each commit page offers:

  • A header made of the first line of the commit message. Select it to open a commitdiff report that compares the commit to its parent commit.
  • author — Who wrote the commit, their email address, and when it was made.
    • Select the author's name to search for that author.
    • Select the email address to search for that address.
  • committer — Who recorded the commit, their email address, and when it was made.
    • Select the committer's name to search for that committer.
    • Select the email address to search for that address.
  • commit — The SHA-1 identifier of the commit.
  • tree — The SHA-1 identifier of the working tree. Select it to open the tree report of the commit.
  • parent — The SHA-1 identifier of the parent commit. Select it to open the commit report of that parent.
  • The complete commit message.
  • The files that were added, changed, moved, or removed. Select a file name to open the blob report of that file.
    • An added file appears with its name and a [new file with mode: 0700] note, in which 0700 is the file's octal permissions.
    • A changed file appears with just its name.
    • A moved file appears with its name and a [moved from path/name with n% similarity] note, in which path/name is where the file used to be and n% is how much of the file matches its parent version.
    • A removed file appears with its name and a [deleted file] note.
Note:
  • In most commits the committer and the author are the same person.
  • Select snapshot to download the repository as it was at that commit.
  • Select parent: SHA-1, where SHA-1 stands for a SHA-1 identifier, to open the commit report of the parent commit.
  • Select patch to see the commit diff formatted as a plain-text email. That output can be fed to the git am command.

Linked reports

commitdiff

Select commitdiff (in some reports it is labeled diff or diff to current) to compare the data of two commits in unified diff format (a diff). Reached through a commitdiff or diff link, the comparison is against the parent commit. Reached through a diff to current link, it is against the HEAD commit.

The report contains:

  • A header made of the first line of the commit message.
  • author — Who wrote the commit, their email address, and when it was made.
    • Select the author name to search for that author.
    • Select the author email address to search for that address.
  • committer — Who recorded the commit, their email address, and when it was made.
    • Select the committer name to search for that committer.
    • Select the committer email address to search for that address.
  • The files that were added, changed, moved, or removed. Select a file name to open the blob report of that file.
    • An added file appears with its name and a [new file with mode: 0700] note, in which 0700 is the file's octal permissions.
    • A changed file appears with just its name.
    • A moved file appears with its name and a [moved from path/name with n% similarity] note, in which path/name is where the file used to be and n% is the share of lines the commit changed in the file. Select the old location to open the blob report of the earlier file version.
    • A removed file appears with its name and a [deleted file] note.
  • For every file, a header with the exact git diff command, followed by the diff it produces. Select the file name or its short SHA-1 identifier to open the blob report of the file.
Note:

In most commits the committer and the author are the same person.

This report also offers these actions:

  • Select inline to show each file's diff as line-by-line changes.
  • Select parent: SHA-1, where SHA-1 stands for a SHA-1 identifier, to open the commit report of the parent commit.
  • Select patch to see the commit diff formatted as a plain-text email. That output can be fed to the git am command.
  • Select raw to see the commit diff as plain text.
  • Select side by side to show each file's diff in two columns.

Linked reports

heads

Note:

Remote branches are not listed in this report.

Select heads to see the HEAD commit of each local branch. The report contains:

  • The repository path. Select it to open the summary report of the repository.
  • A branch list that gives:
    • How long ago the latest (HEAD) commit was made, or its date.
    • The branch name. Select it to open the shortlog report of that branch.

Linked reports

history

Select history to see how one file has changed over time. The report contains:

  • A header made of the first line of the message of the commit you came from. Select that first line of the commit message to open the commit report.
  • The path of the file. Select a directory name to open its tree report, or select the file name to open its blob report.
  • Every commit that touched the file, each with:
    • How long ago the commit was made, or its date.
    • The author's name. Select it to search for that author.
    • The first line of the commit message. Select it to open the commit report.
Note:

Select raw to get the file as plain text.

Linked reports

log

Select log to read the full log entry of every commit. The report contains:

  • The repository path. Select it to open the summary report of the repository.
  • For each commit in the repository:
    • A header with how long ago the commit was made (or its date) and the first line of its message. Select that first line to open the commit report.
    • The author, plus the date and time of the commit. Select the author's name to search for that author.
    • The complete commit message.

Linked reports

shortlog

Select shortlog for a condensed list of the log entries of all commits. The report contains:

  • The repository path. Select it to open the summary report of the repository.

  • For each commit in the repository:

    • How long ago the latest commit was made, or its date.
    • The author. Select the name to search for that author.
    • The first line of the commit message. Select it to open the commit report.
Note:

Select snapshot to download the repository as it was at that commit.

Linked reports

summary

Select summary for an overview of the repository. The report contains:

  • description — The name and description of the repository, when set.
  • owner — Who owns the repository.
  • last change — When the most recent commit was made.
  • shortlog — Select shortlog to open the shortlog report of the repository, a condensed list showing for each commit:
    • How long ago the latest commit was made, or its date.
    • The author. Select the name to search for that author.
    • The first line of the commit message. Select it to open the commit report.
  • tags — Select tags to open the tags report of the repository, a list showing for each Git tag:
    • How long ago the commit was made, or its date.
    • The tag name. Select it to open the commit report.
    • The tag message. Select it to open the tag report.
    • The tag object. Select it to open the tag report.
  • heads — Select heads to open the heads report of the repository, a list showing for each local tracking branch:
    • How long ago the latest commit was made, or its date.
    • The branch name. Select it to open the shortlog report of that branch.
Note:

Select snapshot to download the repository as it was at the latest commit.

Linked reports

tags

Select tags (in some reports, tag) to see the tags of the repository. When you open a single tag, the report shows:

  • A header with the tag name. Select it to open the commit report.
  • object — The SHA-1 identifier of the commit object.
  • author — Who wrote the commit, their email address, and when it was made.
    • Select the author's name to search for that author.
    • Select the email address to search for that address.
  • The tag message.

When you open the report from a list of tags, it shows:

  • The repository path. Select it to open the summary report of the repository.
  • For each tag:
    • How long ago the commit was made, or its date.
    • The tag name. Select it to open the commit report.
    • The tag message. Select it to open the tag report.
    • The tag object. Select it to open the tag report.
    • The first line of the commit message.

Linked reports

tree

Select tree to browse the working tree as of one commit. The report contains:

  • A header made of the first line of the commit message. Select it to open the commit report.
  • For every file and directory in the working tree:
    • Its permissions, written as symbolic characters.
    • Its size in bytes, or a hyphen (-) for a directory.
    • Its name. Select a directory name to open the tree report of that directory, or select a file name to open the blob report of that file.
      Note:
      • Select snapshot to download this version of the working tree.
      • Select raw to see a file as plain text.

Linked reports

Search Gitweb data

Besides the reports, Gitweb has a search function for finding repository information.

Follow these steps to search:

  1. Use the menu left of the search box in the upper-left corner to pick a search type:
    • commit — Looks through commit authors and messages.
    • grep — Looks inside the files of the current working tree.
    • author — Looks for a commit date, author name, or author email address.
    • committer — Looks for a commit date, committer name, or committer email address.
    • pickaxe — Finds every commit whose changes involve the terms you enter.
  2. Type your terms into the search box.
  3. To write the search text as a Perl-Compatible Regular Expression (PCRE), tick the re checkbox.
    Note:

    PCRE searches in Gitweb ignore letter case.

  4. Press Enter and the results are displayed.
Was this answer helpful? 0 Users Found This Useful (0 Votes)