git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <junkio@cox.net>
To: Alp Toker <alp@atoker.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation
Date: Fri, 14 Jul 2006 14:46:21 -0700	[thread overview]
Message-ID: <7vk66foo5u.fsf@assigned-by-dhcp.cox.net> (raw)
In-Reply-To: <1152872688966-git-send-email-alp@atoker.com> (Alp Toker's message of "Fri, 14 Jul 2006 11:24:47 +0100")

Alp Toker <alp@atoker.com> writes:

> Commit c3f17061be95de3498449a548e93883aebff23d6 was causing warnings
> during doc generation due to bad asciidoc markup.

It seems that the '+++' quoting does not seem to work with older asciidoc.

However, I just noticed that what the text talks about is wrong
to begin with (not your fault):

> +	rsync://host.xz/path/to/repo.git/
> +	http://host.xz/path/to/repo.git/
> +	https://host.xz/path/to/repo.git/
> +	git://host.xz/path/to/repo.git/
> +	git://host.xz/~user/path/to/repo.git/
> +	ssh://[user@]host.xz/path/to/repo.git/
> +	ssh://[user@]host.xz/~user/path/to/repo.git/
> +	ssh://[user@]host.xz/~/path/to/repo.git
>  
>  SSH Is the default transport protocol and also supports an
>  scp-like syntax.  Both syntaxes support username expansion,
>  as does the native git protocol. The following three are
>  identical to the last three above, respectively:
>  
> +	host.xz:/path/to/repo.git/
> +	host.xz:~user/path/to/repo.git/
> +	host.xz:path/to/repo.git

So how about something like this instead, until people have up
to date asciidoc?

diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 93378d2..a5519e5 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -10,12 +10,12 @@ to name the remote repository:
 - https://host.xz/path/to/repo.git/
 - git://host.xz/path/to/repo.git/
 - git://host.xz/~user/path/to/repo.git/
-- ssh://+++[user@+++]host.xz/path/to/repo.git/
-- ssh://+++[user@+++]host.xz/~user/path/to/repo.git/
-- ssh://+++[user@+++]host.xz/~/path/to/repo.git
+- ssh://host.xz/path/to/repo.git/
+- ssh://host.xz/~user/path/to/repo.git/
+- ssh://host.xz/~/path/to/repo.git
 ===============================================================
 
-SSH Is the default transport protocol and also supports an
+SSH is the default transport protocol and also supports an
 scp-like syntax.  Both syntaxes support username expansion,
 as does the native git protocol. The following three are
 identical to the last three above, respectively:
@@ -26,6 +26,10 @@ identical to the last three above, respe
 - host.xz:path/to/repo.git
 ===============================================================
 
+In addition, you can specify the name of the user to log in as
+by saying `ssh://user@host.xz/\...` and `user@host.xz:\...` for
+the SSH protocol.
+
 To sync with a local directory, use:
 
 ===============================================================

  parent reply	other threads:[~2006-07-14 21:46 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-07-14 10:24 [PATCH] Revert "Documentation: Fix ssh://[user@]host.xz URL" Alp Toker
2006-07-14 10:24 ` [PATCH] Documentation: Fix ssh:// URLs in generated documentation Alp Toker
2006-07-14 10:24   ` [PATCH] Documentation: Minor capitalization typofix Alp Toker
2006-07-14 21:46   ` Junio C Hamano [this message]
2006-07-14 21:50 ` [PATCH] urls.txt: Use substitution to escape square brackets Jonas Fonseca
2006-07-14 22:07   ` Junio C Hamano
2006-07-14 23:01     ` Alp Toker
2006-07-14 23:13       ` Junio C Hamano
2006-07-14 23:57         ` Alp Toker
2006-07-14 23:42   ` Junio C Hamano
2006-07-15  0:38     ` Alp Toker
2006-07-15  7:44     ` [PATCH] Make asciidoc related rules depend on asciidoc.conf Jonas Fonseca
  -- strict thread matches above, loose matches on Subject: below --
2006-07-12 21:55 [PATCH] Documentation: Fix ssh:// URLs in generated documentation Alp Toker
2006-07-13  4:58 ` Junio C Hamano
2006-07-13  5:48   ` Alp Toker

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=7vk66foo5u.fsf@assigned-by-dhcp.cox.net \
    --to=junkio@cox.net \
    --cc=alp@atoker.com \
    --cc=git@vger.kernel.org \
    /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).