From 8efb2a723ab7b030d05bd1bfc0db4fa4127498a2 Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Tue, 18 Aug 2009 19:45:33 -0700 Subject: [PATCH] Cleanup section anchors to be more useful By putting the anchor before the title, we get the desired effect when jumping to it, which is to show the title at the top of the browser window. Signed-off-by: Shawn O. Pearce --- Documentation/cmd-flush-caches.txt | 2 +- Documentation/cmd-show-caches.txt | 2 +- Documentation/config-gerrit.txt | 50 ++++++++++++++-------------- Documentation/config-gitweb.txt | 2 +- Documentation/config-replication.txt | 8 ++--- 5 files changed, 32 insertions(+), 32 deletions(-) diff --git a/Documentation/cmd-flush-caches.txt b/Documentation/cmd-flush-caches.txt index 516c96635d..795af04c59 100644 --- a/Documentation/cmd-flush-caches.txt +++ b/Documentation/cmd-flush-caches.txt @@ -95,7 +95,7 @@ SEE ALSO -------- * link:cmd-show-caches.html[gerrit show-caches] -* link:config-gerrit.html#section_cache[Cache Configuration] +* link:config-gerrit.html#cache[Cache Configuration] * link:config-gerrit.html#cache_names[Standard Caches] GERRIT diff --git a/Documentation/cmd-show-caches.txt b/Documentation/cmd-show-caches.txt index 57df02568a..301864ae36 100644 --- a/Documentation/cmd-show-caches.txt +++ b/Documentation/cmd-show-caches.txt @@ -70,7 +70,7 @@ SEE ALSO -------- * link:cmd-flush-caches.html[gerrit flush-caches] -* link:config-gerrit.html#section_cache[Cache Configuration] +* link:config-gerrit.html#cache[Cache Configuration] * link:config-gerrit.html#cache_names[Standard Caches] GERRIT diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt index 980415c70d..a112275603 100644 --- a/Documentation/config-gerrit.txt +++ b/Documentation/config-gerrit.txt @@ -24,8 +24,8 @@ Sample `gerrit.config`: diskbuffer = 10 m ---- -Section auth -~~~~~~~~~~~~ +[[auth]]Section auth +~~~~~~~~~~~~~~~~~~~~ See also link:config-sso.html[SSO configuration]. @@ -152,8 +152,8 @@ drops to 0, or close to 0: + By default, unset/false. -Section cache[[section_cache]] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +[[cache]]Section cache +~~~~~~~~~~~~~~~~~~~~~~ cache.directory:: + @@ -213,7 +213,7 @@ Default is 5 MiB. + Common unit suffixes of 'k', 'm', or 'g' are supported. -Standard Caches[[cache_names]] +[[cache_names]]Standard Caches ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ cache `"accounts"`:: @@ -315,8 +315,8 @@ this cache is approximately 248 bytes, depending on the JVM. See also link:cmd-flush-caches.html[gerrit flush-caches]. -Section contactstore -~~~~~~~~~~~~~~~~~~~~ +[[contactstore]]Section contactstore +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ contactstore.url:: + @@ -330,8 +330,8 @@ contactstore.appsec:: + Shared secret of the web based contact store. -Section core -~~~~~~~~~~~~ +[[core]]Section core +~~~~~~~~~~~~~~~~~~~~ core.packedGitWindowSize:: + @@ -399,8 +399,8 @@ unused mapped spaces fast enough. Default on JGit is false. Although potentially slower, it yields much more predictable behavior. -Section gerrit -~~~~~~~~~~~~~~ +[[gerrit]]Section gerrit +~~~~~~~~~~~~~~~~~~~~~~~~ gerrit.basePath:: + @@ -434,8 +434,8 @@ By default unset, as the git daemon must be configured externally by the system administrator, and might not even be running on the same host as Gerrit. -Section gitweb[[section_gitweb]] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +[[gitweb]]Section gitweb +~~~~~~~~~~~~~~~~~~~~~~~~ See also link:config-gitweb.html[Gitweb Integration]. @@ -449,8 +449,8 @@ Gerrit appends any necessary query arguments onto the end of this URL. For example, "?p=$project.git;h=$commit". -Section ldap -~~~~~~~~~~~~ +[[ldap]]Section ldap +~~~~~~~~~~~~~~~~~~~~ LDAP integration is only enabled if `auth.type` was set to `HTTP_LDAP`. See above for a detailed description of the auth.type @@ -559,8 +559,8 @@ Attributes such as `$\{dn\}` or `$\{uidNumber\}` may be useful. Default is `(memberUid=$\{username\})`, matching RFC 2307. -Section mimetype -~~~~~~~~~~~~~~~~ +[[mimetype]]Section mimetype +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ mimetype..safe:: + @@ -584,8 +584,8 @@ Common examples: safe = true ==== -Section repo -~~~~~~~~~~~~ +[[repo]]Section repo +~~~~~~~~~~~~~~~~~~~~ repo.showDownloadCommand:: + @@ -595,8 +595,8 @@ instance are generally worked on with the repo multi-repository tool. + By default, false, as not all instances will deploy repo. -Section sendemail -~~~~~~~~~~~~~~~~~ +[[sendemail]]Section sendemail +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ sendemail.enable:: + @@ -636,8 +636,8 @@ email from Gerrit. + By default, unset, permitting delivery to any email address. -Section sshd -~~~~~~~~~~~~ +[[sshd]] Section sshd +~~~~~~~~~~~~~~~~~~~~ sshd.listenAddress:: + @@ -698,8 +698,8 @@ Supported MACs: hmac-md5, hmac-md5-96, hmac-sha1, hmac-sha1-96. + By default, all supported MACs are available. -Section user -~~~~~~~~~~~~ +[[user]] Section user +~~~~~~~~~~~~~~~~~~~~ name:: + diff --git a/Documentation/config-gitweb.txt b/Documentation/config-gitweb.txt index 72cad7cf1e..9f3b9982a2 100644 --- a/Documentation/config-gitweb.txt +++ b/Documentation/config-gitweb.txt @@ -37,7 +37,7 @@ high-traffic sites like kernel.org or repo.or.cz. See Also -------- -* link:config-gerrit.html#section_gitweb[Section gitweb] +* link:config-gerrit.html#gitweb[Section gitweb] GERRIT ------ diff --git a/Documentation/config-replication.txt b/Documentation/config-replication.txt index 374d42e782..541e4ce252 100644 --- a/Documentation/config-replication.txt +++ b/Documentation/config-replication.txt @@ -50,7 +50,7 @@ different hosts: To manually trigger replication at runtime, see link:cmd-replicate.html[gerrit replicate]. -File `replication.config`[[replication_config]] +[[replication_config]]File `replication.config` ----------------------------------------------- The optional file `'$site_path'/replication.config` is a Git-style @@ -67,8 +67,8 @@ into different remote sections, so that replication to the slower connection does not starve out the faster local one. The example file above does this. -Section remote[[section_remote]] -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +[[remote]]Section remote +~~~~~~~~~~~~~~~~~~~~~~~~ In the keys below, the portion is unused by Gerrit, but must be unique to distinguish the different sections if more than one remote @@ -152,7 +152,7 @@ parallel pushing. By default, 1 thread. -File `~/.ssh/config`[[ssh_config]] +[[ssh_config]]File `~/.ssh/config` ---------------------------------- If present, Gerrit reads and caches `~/.ssh/config` at startup, and