Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:42:33
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2016-06-15 · [PATCH] Documentation: Fix ssh:// URLs in generated documentation · Alp Toker <hidden>
- 2016-06-15 · Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation · Junio C Hamano <hidden>
- 2016-06-15 · Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation · Alp Toker <hidden>
- 2016-06-15 · [PATCH] Documentation: Fix ssh:// URLs in generated documentation · Alp Toker <hidden>
Alp Toker [off-list ref] 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: ===============================================================