cgit with patches for sandboxing using qssb
Aller au fichier
John Keeping 30304d8156 log: allow users to follow a file
Teach the "log" UI to behave in the same way as "git log --follow", when
given a suitable instruction by the user.  The default behaviour remains
to show the log without following renames, but the follow behaviour can
be activated by following a link in the page header.

Follow is not the default because outputting merges in follow mode is
tricky ("git log --follow" will not show merges).  We also disable the
graph in follow mode because the commit graph is not simplified so we
end up with frequent gaps in the graph and many lines that do not
connect with any commits we're actually showing.

We also teach the "diff" and "commit" UIs to respect the follow flag on
URLs, causing the single-file version of these UIs to detect renames.
This feature is needed only for commits that rename the path we're
interested in.

For commits before the file has been renamed (i.e. that appear later in
the log list) we change the file path in the links from the log to point
to the old name; this means that links to commits always limit by the
path known to that commit.  If we didn't do this we would need to walk
down the log diff'ing every commit whenever we want to show a commit.
The drawback is that the "Log" link in the top bar of such a page links
to the log limited by the old name, so it will only show pre-rename
commits.  I consider this a reasonable trade-off since the "Back" button
still works and the log matches the path displayed in the top bar.

Since following renames requires running diff on every commit we
consider, I've added a knob to the configuration file to globally
enable/disable this feature.  Note that we may consider a large number
of commits the revision walking machinery no longer performs any path
limitation so we have to examine every commit until we find a page full
of commits that affect the target path or something related to it.

Suggested-by: René Neumann <necoro@necoro.eu>
Signed-off-by: John Keeping <john@keeping.me.uk>
2015-08-12 16:57:46 +02:00
contrib/hooks contrib/hooks: add sample post-receive hook using agefile 2015-08-12 14:06:36 +02:00
filters filters: apply HTML escaping 2015-08-12 14:13:44 +02:00
git@a17c56c056 git: update to v2.5.0 2015-08-12 14:09:05 +02:00
tests t0110: Chain together using && 2015-08-12 15:16:05 +02:00
.gitignore tests/.gitignore: update for using Git's test infrastructure 2013-04-08 22:27:53 +02:00
.gitmodules Delete submodules.sh and prepare for using git-submodule 2007-09-03 22:54:51 +02:00
.mailmap mailmap: source before lighttpd 2014-01-17 16:04:27 +01:00
AUTHORS authors: specify maintainers 2014-01-14 02:00:07 +01:00
cache.c cache: don't use an integer as a NULL pointer 2015-03-09 17:40:44 +01:00
cache.h Switch to exclusively using global ctx 2014-01-17 00:44:54 +01:00
cgit-doc.css Add cgit-doc.css 2009-02-12 10:24:25 +01:00
cgit.c log: allow users to follow a file 2015-08-12 16:57:46 +02:00
cgit.css Remove no-op link from submodule entries 2015-03-13 14:52:52 +01:00
cgit.h log: allow users to follow a file 2015-08-12 16:57:46 +02:00
cgit.mk Makefile: add a target to run CGit through sparse 2015-03-09 17:38:22 +01:00
cgit.png shrink cgit.png file size 2015-02-15 22:06:24 +01:00
cgitrc.5.txt log: allow users to follow a file 2015-08-12 16:57:46 +02:00
cmd.c about: always ensure page has a trailing slash 2015-08-12 15:03:32 +02:00
cmd.h about: always ensure page has a trailing slash 2015-08-12 15:03:32 +02:00
configfile.c Update copyright information 2014-01-08 15:10:49 +01:00
configfile.h Use strbuf for reading configuration files 2013-08-12 13:14:10 -06:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
favicon.ico Add favicon 2013-05-31 02:52:24 +02:00
filter.c Avoid non-ANSI function declarations 2015-03-09 17:38:30 +01:00
gen-version.sh gen-version.sh: check if git is available before trying to call it 2014-02-05 15:09:15 +01:00
html.c html: avoid using a plain integer as a NULL pointer 2015-03-09 17:41:14 +01:00
html.h html.c: add various strbuf and varadic helpers 2013-04-08 16:10:11 +02:00
Makefile git: update to v2.5.0 2015-08-12 14:09:05 +02:00
parsing.c Drop return value from parse_user() 2015-03-05 15:54:47 +01:00
README remove trailing whitespaces from source files 2014-04-17 12:55:09 +02:00
robots.txt robots.txt: disallow access to snapshots 2013-08-12 13:14:10 -06:00
scan-tree.c scan-tree: make some variables 'static' 2015-03-09 17:39:01 +01:00
scan-tree.h Add support for 'project-list' option 2010-08-04 03:09:32 +02:00
shared.c shared: make cgit_diff_tree_cb public 2015-08-12 16:57:30 +02:00
ui-atom.c git: update to v2.0.3 2014-07-28 02:01:35 +02:00
ui-atom.h Add atom-support 2008-08-01 22:12:34 +02:00
ui-blob.c Avoid signed bitfields 2015-03-09 17:38:46 +01:00
ui-blob.h readme: use string_list instead of space deliminations 2013-05-26 16:30:03 +02:00
ui-clone.c git: update to v2.5.0 2015-08-12 14:09:05 +02:00
ui-clone.h Switch to exclusively using global ctx 2014-01-17 00:44:54 +01:00
ui-commit.c ui-shared: remove toggle_ssdiff arg to cgit_diff_link() 2014-12-13 12:38:42 +01:00
ui-commit.h ui-commit: Limit diff based on path limit in qry.path 2010-06-19 10:40:23 +02:00
ui-diff.c log: allow users to follow a file 2015-08-12 16:57:46 +02:00
ui-diff.h Allow for creating raw diffs with cgit_print_diff() 2013-08-16 13:15:37 -06:00
ui-log.c log: allow users to follow a file 2015-08-12 16:57:46 +02:00
ui-log.h ui-log: Add "commit-sort" option for controlling commit ordering 2012-10-17 16:30:29 +02:00
ui-patch.c ui-patch: match git-format-patch(1) output 2014-12-28 14:44:44 +01:00
ui-patch.h ui-patch: Rename variables 2013-08-20 19:55:54 +02:00
ui-plain.c git: update for v2.3.0 2015-02-08 18:11:09 +01:00
ui-plain.h Switch to exclusively using global ctx 2014-01-17 00:44:54 +01:00
ui-refs.c log: allow users to follow a file 2015-08-12 16:57:46 +02:00
ui-refs.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-repolist.c log: allow users to follow a file 2015-08-12 16:57:46 +02:00
ui-repolist.h Prepare for 'about site' page / add 'root-readme' option to cgitrc 2008-04-29 01:06:30 +02:00
ui-shared.c log: allow users to follow a file 2015-08-12 16:57:46 +02:00
ui-shared.h log: allow users to follow a file 2015-08-12 16:57:46 +02:00
ui-snapshot.c Add Etags for snapshots 2015-01-28 13:42:49 +01:00
ui-snapshot.h Remove unused parameter from cgit_print_snapshot() 2014-02-21 18:19:00 +01:00
ui-ssdiff.c Avoid non-ANSI function declarations 2015-03-09 17:38:30 +01:00
ui-ssdiff.h ui-ssdiff: move LCS table away from the stack 2012-01-03 15:16:01 +00:00
ui-stats.c ui-stats: make cgit_period definitions 'static const' 2015-03-09 17:40:02 +01:00
ui-stats.h ui-stats: make cgit_period definitions 'static const' 2015-03-09 17:40:02 +01:00
ui-summary.c Avoid non-ANSI function declarations 2015-03-09 17:38:30 +01:00
ui-summary.h readme: use string_list instead of space deliminations 2013-05-26 16:30:03 +02:00
ui-tag.c filter: add page source to email filter 2014-01-14 02:00:07 +01:00
ui-tag.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-tree.c log: allow users to follow a file 2015-08-12 16:57:46 +02:00
ui-tree.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00

cgit - CGI for Git
==================

This is an attempt to create a fast web interface for the Git SCM, using a
built-in cache to decrease server I/O pressure.

Installation
------------

Building cgit involves building a proper version of Git. How to do this
depends on how you obtained the cgit sources:

a) If you're working in a cloned cgit repository, you first need to
initialize and update the Git submodule:

    $ git submodule init     # register the Git submodule in .git/config
    $ $EDITOR .git/config    # if you want to specify a different url for git
    $ git submodule update   # clone/fetch and checkout correct git version

b) If you're building from a cgit tarball, you can download a proper git
version like this:

    $ make get-git

When either a) or b) has been performed, you can build and install cgit like
this:

    $ make
    $ sudo make install

This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
can configure this location (and a few other things) by providing a `cgit.conf`
file (see the Makefile for details).

If you'd like to compile without Lua support, you may use:

    $ make NO_LUA=1

And if you'd like to specify a Lua implementation, you may use:

    $ make LUA_PKGCONFIG=lua5.1

If this is not specified, the Lua implementation will be auto-detected,
preferring LuaJIT if many are present. Acceptable values are generally "lua",
"luajit", "lua5.1", and "lua5.2".


Dependencies
------------

* libzip
* libcrypto (OpenSSL)
* libssl (OpenSSL)
* optional: luajit or lua, most reliably used when pkg-config is available

Apache configuration
--------------------

A new `Directory` section must probably be added for cgit, possibly something
like this:

    <Directory "/var/www/htdocs/cgit/">
        AllowOverride None
        Options +ExecCGI
        Order allow,deny
        Allow from all
    </Directory>


Runtime configuration
---------------------

The file `/etc/cgitrc` is read by cgit before handling a request. In addition
to runtime parameters, this file may also contain a list of repositories
displayed by cgit (see `cgitrc.5.txt` for further details).

The cache
---------

When cgit is invoked it looks for a cache file matching the request and
returns it to the client. If no such cache file exists (or if it has expired),
the content for the request is written into the proper cache file before the
file is returned.

If the cache file has expired but cgit is unable to obtain a lock for it, the
stale cache file is returned to the client. This is done to favour page
throughput over page freshness.

The generated content contains the complete response to the client, including
the HTTP headers `Modified` and `Expires`.

Online presence
---------------

* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>

* Patches, bug reports, discussions and support should go to the cgit
  mailing list: <cgit@lists.zx2c4.com>. To sign up, visit
  <http://lists.zx2c4.com/mailman/listinfo/cgit>