git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: git@vger.kernel.org, "Jean-Noël Avila" <jn.avila@free.fr>
Subject: Re: [PATCH 3/4] git-daemon doc: update mark-up of synopsis option descriptions
Date: Thu, 01 May 2025 16:22:40 -0700	[thread overview]
Message-ID: <xmqq34dnx6f3.fsf@gitster.g> (raw)
In-Reply-To: <xmqqa57wvsbb.fsf@gitster.g> (Junio C. Hamano's message of "Thu, 01 May 2025 16:12:40 -0700")

Here are incremental changes relative to the previous round, taking
inspiration from your suggestions.

I think the sample option, sitename, and pathname must be typed
verbatim by the readers if the behaviour described in the text
is to be reproduced, so changed them in the base-path description
all to be marked up as `literal string`.


diff --git c/Documentation/git-daemon.adoc w/Documentation/git-daemon.adoc
index 3eb9332e55..bc3f77405e 100644
--- c/Documentation/git-daemon.adoc
+++ w/Documentation/git-daemon.adoc
@@ -32,7 +32,7 @@ that service if it is enabled.
 It verifies that the directory has the magic file "git-daemon-export-ok", and
 it will refuse to export any Git directory that hasn't explicitly been marked
 for export this way (unless the `--export-all` parameter is specified). If you
-pass some directory paths as 'git daemon' arguments, the offers are limited to
+pass some directory paths as `git daemon` arguments, the offers are limited to
 repositories within those directories.
 
 By default, only `upload-pack` service is enabled, which serves
@@ -49,15 +49,15 @@ OPTIONS
 `--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
+	`git daemon` will refuse to start when this option is enabled and no
 	directory arguments are provided.
 
 `--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`.
+	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 from `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



  reply	other threads:[~2025-05-01 23:22 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-01 21:34 [PATCH 0/4] A handful of doc synopsis/options update Junio C Hamano
2025-05-01 21:34 ` [PATCH 1/4] git-verify-* doc: update mark-up of synopsis option descriptions Junio C Hamano
2025-05-01 22:43   ` Eric Sunshine
2025-05-01 23:10     ` Junio C Hamano
2025-05-01 21:34 ` [PATCH 2/4] git-{var,write-tree} docs: " Junio C Hamano
2025-05-01 21:34 ` [PATCH 3/4] git-daemon doc: " Junio C Hamano
2025-05-01 22:52   ` Eric Sunshine
2025-05-01 23:12     ` Junio C Hamano
2025-05-01 23:22       ` Junio C Hamano [this message]
2025-05-01 21:34 ` [WIP PATCH 4/4] git-worktree " Junio C Hamano
2025-05-03  1:15 ` [PATCH v2 0/3] A handful of doc synopsis/options update Junio C Hamano
2025-05-03  1:15   ` [PATCH v2 1/3] git-verify-* doc: update mark-up of synopsis option descriptions Junio C Hamano
2025-05-03  1:15   ` [PATCH v2 2/3] git-{var,write-tree} docs: " Junio C Hamano
2025-05-03  1:15   ` [PATCH v2 3/3] git-daemon doc: " Junio C Hamano
2025-05-07 20:58   ` Additional changes Jean-Noël Avila
2025-05-07 20:58     ` [PATCH] " Jean-Noël Avila
2025-05-08 15:14       ` Junio C Hamano
2025-05-09 12:12         ` Jean-Noël AVILA
2025-05-09 14:35           ` Junio C Hamano
2025-05-09 17:08             ` Jean-Noël AVILA
2025-05-09 18:24               ` Junio C Hamano
2025-05-10 12:33 ` [PATCH v3 0/4] " Jean-Noël Avila
2025-05-10 12:33   ` [PATCH v3 1/4] git-daemon doc: update mark-up of synopsis option descriptions Jean-Noël Avila
2025-05-10 12:33   ` [PATCH v3 2/4] git-{var,write-tree} docs: " Jean-Noël Avila
2025-05-10 12:33   ` [PATCH v3 3/4] git-verify-* doc: " Jean-Noël Avila
2025-05-10 12:33   ` [PATCH v3 4/4] git-var doc: fix usage of $ENV_VAR vs ENV_VAR Jean-Noël Avila

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq34dnx6f3.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=jn.avila@free.fr \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).