From: James Moger Date: Tue, 20 Mar 2012 03:08:16 +0000 (-0400) Subject: Documentation X-Git-Tag: v0.9.0~44 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=ff3f0e3533b48153dc7328a0733a9af2121be107;p=gitblit.git Documentation --- diff --git a/NOTICE b/NOTICE index 5e498037..f394d86f 100644 --- a/NOTICE +++ b/NOTICE @@ -71,6 +71,22 @@ Jetty http://eclipse.org/jetty +--------------------------------------------------------------------------- +Apache Lucene +--------------------------------------------------------------------------- + Apache Lucene, released under the + Apache Software License, Version 2.0. + + http://lucene.apache.org + +--------------------------------------------------------------------------- +Groovy +--------------------------------------------------------------------------- + Groovy, released under the + Apache Software License, Version 2.0. + + http://groovy.codehaus.org + --------------------------------------------------------------------------- SLF4J --------------------------------------------------------------------------- @@ -190,4 +206,12 @@ magnifying glass search icon Creative Commons CC-BY License. http://gnome.org - \ No newline at end of file + +--------------------------------------------------------------------------- +GLYHPICONS +--------------------------------------------------------------------------- + GLPYHICONS, released under the + Creative Commons CC-BY License. + + http://glyphicons.com + \ No newline at end of file diff --git a/docs/01_features.mkd b/docs/01_features.mkd index 7eb9e645..cb37f5de 100644 --- a/docs/01_features.mkd +++ b/docs/01_features.mkd @@ -13,6 +13,7 @@ - Gitweb inspired web UI - Groovy pre- and post- push hook scripts, per-repository or globally for all repositories - Email push notifications *(via sendmail.groovy push script)* +- Lucene indexing of specified repository branches - Administrators may create, edit, rename, or delete repositories through the web UI or RPC interface - Administrators may create, edit, rename, or delete users through the web UI or RPC interface - Administrators may create, edit, rename, or delete teams through the web UI or RPC interface diff --git a/docs/01_setup.mkd b/docs/01_setup.mkd index 1160d8e9..9c386d96 100644 --- a/docs/01_setup.mkd +++ b/docs/01_setup.mkd @@ -141,15 +141,6 @@ ProxyPreserveHost On Allow from all </Proxy> -# Turn on Proxy status reporting at /status -# This should be better protected than: Allow from all -ProxyStatus On -<Location /status> - SetHandler server-status - Order Deny,Allow - Allow from all -</Location> - # The proxy context path must match the Gitblit context path. # For Gitblit GO, see server.contextPath in gitblit.properties. @@ -376,6 +367,23 @@ All three sources are checked and merged into a unique list of destination addre **NOTE:** Care should be taken when devising your notification scheme as it relates to any VIEW restricted repositories you might have. Setting a global mailing list and activating push notifications for a VIEW restricted repository may send unwanted emails. +## Lucene Search Integration + +*SINCE 0.9.0* + +Repositories may optionally be indexed using the Lucene search engine. Lucene indexing is an opt-in feature which means that no repositories are automatically indexed. Like anything else, this has benefits and drawbacks. + +You may specify which branches should be indexed per-repository in the *Edit Repository* page. New/empty repositories can not pre-specify indexed branches; you can only specify indexed branches for a repository with commits. Indexes are built and incrementally updated on a 2 minute cycle so you may have to wait a few minutes before your index is built or before your latest pushes get indexed. + +**NOTE:** +Repositories that specify indexed branches will redirect to the Lucene search page from the search box in the upper right corner of a repository page. Repositories that do not specify any indexed branches will use the traditional commit search. + +The Lucene search offers several advantages over the traditional commit search: + +1. multi-term searches +2. term-highlighted and syntax-highlighted fragment matches +3. multi-repository searches + ## Client Setup and Configuration ### Https with Self-Signed Certificates You must tell Git/JGit not to verify the self-signed certificate in order to perform any remote Git operations. diff --git a/docs/04_design.mkd b/docs/04_design.mkd index 4fbb2a13..a439edf5 100644 --- a/docs/04_design.mkd +++ b/docs/04_design.mkd @@ -37,6 +37,7 @@ The following dependencies are automatically downloaded by Gitblit GO (or alread - [google-gson](http://code.google.com/google-gson) (Apache 2.0) - [javamail](http://kenai.com/projects/javamail) (CDDL-1.0, BSD, GPL-2.0, GNU-Classpath) - [Groovy](http://groovy.codehaus.org) (Apache 2.0) +- [Lucene](http://lucene.apache.org) (Apache 2.0) ### Other Build Dependencies - [Fancybox image viewer](http://fancybox.net) (MIT and GPL dual-licensed) diff --git a/docs/04_releases.mkd b/docs/04_releases.mkd index 9999c9fa..90500d5f 100644 --- a/docs/04_releases.mkd +++ b/docs/04_releases.mkd @@ -10,12 +10,15 @@ #### changes -- Block pushes to a repository with a working copy (i.e. non-bare repository) (issue-49) +- Reject pushes to a repository with a working copy (i.e. non-bare repository) (issue-49) - Changed default web.datetimestampLongFormat from *EEEE, MMMM d, yyyy h:mm a z* to *EEEE, MMMM d, yyyy HH:mm Z* (issue 50) - Expanded commit age coloring from 2 days to 30 days (issue 57) #### additions +- Added optional Lucene branch indexing (issue 16) +Repository branches may be optionally indexed by Lucene for improved searching. To use this feature you have to specify which branches to index within the *Edit Repository* page. Indexes are automatically built and incrementally updated on a 2 minute cycle. (i.e you will have to wait 2-3 minutes after specifying a branch to be indexed before the index will be built.)

+If a repository has Lucene-indexed branches the *search* form on the repository pages will redirect to the root-level Lucene search page. If the repository does not specify any indexed branches then the traditional repository commit search is used. - Allow specifying timezone to use for Gitblit which is independent of both the JVM and the system timezone (issue 54) **New:** *web.timezone =* - Added a built-in AJP connector for integrating Gitblit GO into an Apache mod_proxy setup (issue 59) diff --git a/resources/gitblit.css b/resources/gitblit.css index 0701a7cf..0b285fb4 100644 --- a/resources/gitblit.css +++ b/resources/gitblit.css @@ -341,6 +341,7 @@ div.header { border: 1px solid #ddd; border-bottom: 0; border-radius: 3px 3px 0 0; + font-weight: bold; } div.commitHeader { diff --git a/src/com/gitblit/Constants.java b/src/com/gitblit/Constants.java index 54a6db3f..879c5a49 100644 --- a/src/com/gitblit/Constants.java +++ b/src/com/gitblit/Constants.java @@ -38,7 +38,7 @@ public class Constants { // The build script extracts this exact line so be careful editing it // and only use A-Z a-z 0-9 .-_ in the string. - public static final String JGIT_VERSION = "JGit 1.2.0 (201112221803-r)"; + public static final String JGIT_VERSION = "JGit 1.3.0 (201202151440-r)"; public static final String ADMIN_ROLE = "#admin";