To unify mark-up used in our documentation to a newer convention,
started by 22293895 (doc: apply synopsis simplification on git-clone
and git-init, 2024-09-24), update the documentation of 'git daemon'
to
* use [synopsis], not [verse] in the SYNOPSIS section
* enclose `--option=<value>` in backquotes
Also, split '--[no-]option' into '--option' and '--no-option'
to make it easier to grep for them.
Signed-off-by: Junio C Hamano <gitster@xxxxxxxxx>
---
Documentation/git-daemon.adoc | 107 +++++++++++++++++-----------------
1 file changed, 54 insertions(+), 53 deletions(-)
diff --git a/Documentation/git-daemon.adoc b/Documentation/git-daemon.adoc
index ede7b935d6..3eb9332e55 100644
--- a/Documentation/git-daemon.adoc
+++ b/Documentation/git-daemon.adoc
@@ -7,21 +7,21 @@ git-daemon - A really simple server for Git repositories
SYNOPSIS
--------
-[verse]
-'git daemon' [--verbose] [--syslog] [--export-all]
- [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
- [--strict-paths] [--base-path=<path>] [--base-path-relaxed]
- [--user-path | --user-path=<path>]
- [--interpolated-path=<pathtemplate>]
- [--reuseaddr] [--detach] [--pid-file=<file>]
- [--enable=<service>] [--disable=<service>]
- [--allow-override=<service>] [--forbid-override=<service>]
- [--access-hook=<path>] [--[no-]informative-errors]
- [--inetd |
- [--listen=<host-or-ipaddr>] [--port=<n>]
- [--user=<user> [--group=<group>]]]
- [--log-destination=(stderr|syslog|none)]
- [<directory>...]
+[synopsis]
+git daemon [--verbose] [--syslog] [--export-all]
+ [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
+ [--strict-paths] [--base-path=<path>] [--base-path-relaxed]
+ [--user-path | --user-path=<path>]
+ [--interpolated-path=<pathtemplate>]
+ [--reuseaddr] [--detach] [--pid-file=<file>]
+ [--enable=<service>] [--disable=<service>]
+ [--allow-override=<service>] [--forbid-override=<service>]
+ [--access-hook=<path>] [--[no-]informative-errors]
+ [--inetd |
+ [--listen=<host-or-ipaddr>] [--port=<n>]
+ [--user=<user> [--group=<group>]]]
+ [--log-destination=(stderr|syslog|none)]
+ [<directory>...]
DESCRIPTION
-----------
@@ -46,26 +46,26 @@ An `upload-archive` also exists to serve 'git archive'.
OPTIONS
-------
---strict-paths::
+`--strict-paths`::
Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
"/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
'git daemon' will refuse to start when this option is enabled and no
directory arguments are provided.
---base-path=<path>::
+`--base-path=<path>`::
Remap all the path requests as relative to the given path.
This is sort of "Git root" - if you run 'git daemon' with
'--base-path=/srv/git' on example.com, then if you later try to pull
'git://example.com/hello.git', 'git daemon' will interpret the path
as `/srv/git/hello.git`.
---base-path-relaxed::
- If --base-path is enabled and repo lookup fails, with this option
+`--base-path-relaxed`::
+ If `--base-path` is enabled and repo lookup fails, with this option
'git daemon' will attempt to lookup without prefixing the base path.
- This is useful for switching to --base-path usage, while still
+ This is useful for switching to `--base-path` usage, while still
allowing the old paths.
---interpolated-path=<pathtemplate>::
+`--interpolated-path=<pathtemplate>`::
To support virtual hosting, an interpolated path template can be
used to dynamically construct alternate paths. The template
supports %H for the target hostname as supplied by the client but
@@ -75,48 +75,48 @@ OPTIONS
After interpolation, the path is validated against the directory
list.
---export-all::
+`--export-all`::
Allow pulling from all directories that look like Git repositories
(have the 'objects' and 'refs' subdirectories), even if they
do not have the 'git-daemon-export-ok' file.
---inetd::
- Have the server run as an inetd service. Implies --syslog (may be
- overridden with `--log-destination=`).
- Incompatible with --detach, --port, --listen, --user and --group
- options.
+`--inetd`::
+ Have the server run as an inetd service. Implies `--syslog` (may
+ be overridden with `--log-destination=`).
+ Incompatible with `--detach`, `--port`, `--listen`, `--user` and
+ `--group` options.
---listen=<host-or-ipaddr>::
+`--listen=<host-or-ipaddr>`::
Listen on a specific IP address or hostname. IP addresses can
be either an IPv4 address or an IPv6 address if supported. If IPv6
- is not supported, then --listen=<hostname> is also not supported and
- --listen must be given an IPv4 address.
+ is not supported, then `--listen=<hostname>` is also not supported
+ and `--listen` must be given an IPv4 address.
Can be given more than once.
Incompatible with `--inetd` option.
---port=<n>::
+`--port=<n>`::
Listen on an alternative port. Incompatible with `--inetd` option.
---init-timeout=<n>::
+`--init-timeout=<n>`::
Timeout (in seconds) between the moment the connection is established
and the client request is received (typically a rather low value, since
that should be basically immediate).
---timeout=<n>::
+`--timeout=<n>`::
Timeout (in seconds) for specific client sub-requests. This includes
the time it takes for the server to process the sub-request and the
time spent waiting for the next client's request.
---max-connections=<n>::
+`--max-connections=<n>`::
Maximum number of concurrent clients, defaults to 32. Set it to
zero for no limit.
---syslog::
+`--syslog`::
Short for `--log-destination=syslog`.
---log-destination=<destination>::
+`--log-destination=<destination>`::
Send log messages to the specified destination.
- Note that this option does not imply --verbose,
+ Note that this option does not imply `--verbose`,
thus by default only error conditions will be logged.
The <destination> must be one of:
+
@@ -135,8 +135,8 @@ none::
The default destination is `syslog` if `--inetd` or `--detach` is specified,
otherwise `stderr`.
---user-path::
---user-path=<path>::
+`--user-path`::
+`--user-path=<path>`::
Allow {tilde}user notation to be used in requests. When
specified with no parameter, a request to
git://host/{tilde}alice/foo is taken as a request to access
@@ -145,23 +145,23 @@ otherwise `stderr`.
taken as a request to access `<path>/foo` repository in
the home directory of user `alice`.
---verbose::
+`--verbose`::
Log details about the incoming connections and requested files.
---reuseaddr::
+`--reuseaddr`::
Use SO_REUSEADDR when binding the listening socket.
This allows the server to restart without waiting for
old connections to time out.
---detach::
- Detach from the shell. Implies --syslog.
+`--detach`::
+ Detach from the shell. Implies `--syslog`.
---pid-file=<file>::
+`--pid-file=<file>`::
Save the process id in 'file'. Ignored when the daemon
is run under `--inetd`.
---user=<user>::
---group=<group>::
+`--user=<user>`::
+`--group=<group>`::
Change daemon's uid and gid before entering the service loop.
When only `--user` is given without `--group`, the
primary group ID for the user is used. The values of
@@ -179,30 +179,31 @@ may also want to set and export `HOME` to point at the home
directory of `<user>` before starting the daemon, and make sure any
Git configuration files in that directory are readable by `<user>`.
---enable=<service>::
---disable=<service>::
+`--enable=<service>`::
+`--disable=<service>`::
Enable/disable the service site-wide per default. Note
that a service disabled site-wide can still be enabled
per repository if it is marked overridable and the
repository enables the service with a configuration
item.
---allow-override=<service>::
---forbid-override=<service>::
+`--allow-override=<service>`::
+`--forbid-override=<service>`::
Allow/forbid overriding the site-wide default with per
repository configuration. By default, all the services
may be overridden.
---[no-]informative-errors::
+`--informative-errors`::
+`--no-informative-errors`::
When informative errors are turned on, git-daemon will report
more verbose errors to the client, differentiating conditions
like "no such repository" from "repository not exported". This
is more convenient for clients, but may leak information about
the existence of unexported repositories. When informative
errors are not enabled, all errors report "access denied" to the
- client. The default is --no-informative-errors.
+ client. The default is `--no-informative-errors`.
---access-hook=<path>::
+`--access-hook=<path>`::
Every time a client connects, first run an external command
specified by the <path> with service name (e.g. "upload-pack"),
path to the repository, hostname (%H), canonical hostname
--
2.49.0-599-g90c2cffacf
