Use the new section title style in Asciidoctor.
We previous use the section title style like:
Section level 1
===============
Section level 2
---------------
Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:
= Section level 1
== Section level 2
So we switched to this style.
Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.
Change-Id: I811dd7238735d98f662767c17086152cd69aea02
diff --git a/Documentation/config-gitweb.txt b/Documentation/config-gitweb.txt
index 5c91277..92260d46 100644
--- a/Documentation/config-gitweb.txt
+++ b/Documentation/config-gitweb.txt
@@ -1,12 +1,10 @@
-Gitweb Integration
-------------------
+== Gitweb Integration
Gerrit Code Review can manage and generate hyperlinks to gitweb,
allowing users to jump from Gerrit content to the same information,
but shown by gitweb.
-Internal/Managed gitweb
-~~~~~~~~~~~~~~~~~~~~~~~
+=== Internal/Managed gitweb
In the internal configuration, Gerrit inspects the request, enforces
its project level access controls, and directly executes `gitweb.cgi`
@@ -37,16 +35,14 @@
After updating `'$site_path'/etc/gerrit.config`, the Gerrit server must
be restarted and clients must reload the host page to see the change.
-Configuration
-^^^^^^^^^^^^^
+==== Configuration
Most of the gitweb configuration file is handled automatically
by Gerrit Code Review. Site specific overrides can be placed in
`'$site_path'/etc/gitweb_config.perl`, as this file is loaded as
part of the generated configuration file.
-Logo and CSS
-^^^^^^^^^^^^
+==== Logo and CSS
If the package-manager installed CGI (`/usr/lib/cgi-bin/gitweb.cgi`)
is being used, the stock CSS and logo files will be served from
@@ -56,8 +52,7 @@
in the same directory as the CGI script itself. This matches with
the default source code distribution, and most custom installations.
-Access Control
-^^^^^^^^^^^^^^
+==== Access Control
Access controls for internally managed gitweb page views are enforced
using the standard project READ +1 permission.
@@ -68,19 +63,16 @@
permissions for any references, make sure to include all parties that should be
able to read the gitweb info for any of the branches in that project.
-External/Unmanaged gitweb
-~~~~~~~~~~~~~~~~~~~~~~~~~
+=== External/Unmanaged gitweb
For the external configuration, gitweb runs under the control of an
external web server, and Gerrit access controls are not enforced. Gerrit
provides configuration parameters for integration with GitWeb.
[[linuxGitWeb]]
-Linux Installation
-^^^^^^^^^^^^^^^^^^
+==== Linux Installation
-Install GitWeb
-++++++++++++++
+===== Install GitWeb
On Ubuntu:
@@ -94,8 +86,7 @@
$ yum install gitweb
====
-Configure GitWeb
-++++++++++++++++
+===== Configure GitWeb
Update `/etc/gitweb.conf`, add the public GIT repositories:
@@ -126,11 +117,9 @@
$favicon = "git-favicon.png";
----
-Configure & Restart Apache Web Server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Configure & Restart Apache Web Server
-Configure Apache
-++++++++++++++++
+===== Configure Apache
Link gitweb to `/var/www/gitweb`, check `/etc/gitweb.conf` if unsure of paths:
@@ -159,8 +148,7 @@
*NOTE* This may have already been added by yum/apt-get. If that's the case, leave as
is.
-Restart the Apache Web Server
-+++++++++++++++++++++++++++++
+===== Restart the Apache Web Server
====
$ sudo /etc/init.d/apache2 restart
@@ -171,8 +159,7 @@
link:http://localhost/gitweb[http://localhost/gitweb]
[[WindowsGitWeb]]
-Windows Installation
-^^^^^^^^^^^^^^^^^^^^
+==== Windows Installation
Instructions are available for installing the GitWeb module distributed with
MsysGit:
@@ -220,8 +207,7 @@
copy the contents of lib into `msysgit/lib/perl5/5.8.8` and overwrite existing files.
-Enable GitWeb Integration
-^^^^^^^^^^^^^^^^^^^^^^^^^
+==== Enable GitWeb Integration
To enable the external gitweb integration, set
link:config-gerrit.html#gitweb.url[gitweb.url] with the URL of your
@@ -258,23 +244,20 @@
`file`, and `filehistory` settings, otherwise the configuration will
not be used.
-Access Control
-++++++++++++++
+===== Access Control
Gitweb access controls can be implemented using standard web server
access controls. This isn't typically integrated with Gerrit's own
access controls. Caution must be taken to ensure the controls are
consistent if access needs to be restricted.
-Caching Gitweb
-++++++++++++++
+===== Caching Gitweb
If your repository set is large and you are expecting a lot
of users, you may want to look at the caching forks used by
high-traffic sites like kernel.org or repo.or.cz.
-Alternatives to gitweb
-~~~~~~~~~~~~~~~~~~~~~~
+=== Alternatives to gitweb
There are other alternatives to gitweb that can also be used with
Gerrit, such as cgit.
@@ -282,8 +265,7 @@
It is also possible to define custom patterns.
-See Also
-~~~~~~~~
+=== See Also
* link:config-gerrit.html#gitweb[Section gitweb]
* link:http://hjemli.net/git/cgit/[cgit]
