diff options
| author | Jean-Noël Avila <jn.avila@free.fr> | 2023-12-25 21:21:26 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-12-26 11:06:55 -0800 |
| commit | 2162f9f6f86df4f49c3a716b5beb3952104ea8b8 (patch) | |
| tree | 9f0fec3c23e0ef98bbb46ec8ceec200355330c89 /Documentation/gitweb.conf.txt | |
| parent | 055bb6e9969085777b7fab83e3fee0017654f134 (diff) | |
| download | git-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.xz | |
doc: enforce dashes in placeholders
The CodingGuidelines documents stipulates that multi-word placeholders
are to be separated by dashes, not underscores nor spaces.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gitweb.conf.txt')
| -rw-r--r-- | Documentation/gitweb.conf.txt | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt index 59fc1d2741..85983587fc 100644 --- a/Documentation/gitweb.conf.txt +++ b/Documentation/gitweb.conf.txt @@ -343,7 +343,7 @@ $home_link_str:: Label for the "home link" at the top of all pages, leading to `$home_link` (usually the main gitweb page, which contains the projects list). It is used as the first component of gitweb's "breadcrumb trail": - `<home link> / <project> / <action>`. Can be set at build time using + `<home-link> / <project> / <action>`. Can be set at build time using the `GITWEB_HOME_LINK_STR` variable. By default it is set to "projects", as this link leads to the list of projects. Another popular choice is to set it to the name of site. Note that it is treated as raw HTML so it @@ -604,9 +604,9 @@ Many gitweb features can be enabled (or disabled) and configured using the Each `%feature` hash element is a hash reference and has the following structure: ---------------------------------------------------------------------- -"<feature_name>" => { - "sub" => <feature-sub (subroutine)>, - "override" => <allow-override (boolean)>, +"<feature-name>" => { + "sub" => <feature-sub-(subroutine)>, + "override" => <allow-override-(boolean)>, "default" => [ <options>... ] }, ---------------------------------------------------------------------- @@ -614,7 +614,7 @@ Some features cannot be overridden per project. For those features the structure of appropriate `%feature` hash element has a simpler form: ---------------------------------------------------------------------- -"<feature_name>" => { +"<feature-name>" => { "override" => 0, "default" => [ <options>... ] }, |