# [PATCH] Documentation: Fix ssh:// URLs in generated documentation 3 messages from 2006-07-12 to 2006-07-13. Participants: Alp Toker, Junio C Hamano. Thread: https://gitlist.dev/t/4864 ## Alp Toker, 2006-07-12 21:55 Subject: [PATCH] Documentation: Fix ssh:// URLs in generated documentation Message-ID: <11527413212127-git-send-email-alp@atoker.com> URL: https://gitlist.dev/e/11527413212127-git-send-email-alp%40atoker.com ``` Commit c3f17061be95de3498449a548e93883aebff23d6 was causing warnings during doc generation due to bad asciidoc markup. This resulted in "ssh://[user@]host.xz/path/to/repo.git/" being rendered as "host.xz/path/to/repo.git/" in the man pages and html output. This patch converts sections listing URL formats to verbatim. It also changes a minor capitalization inconsistency which ended up appearing in several man pages by inclusion. Signed-off-by: Alp Toker --- Documentation/urls.txt | 34 ++++++++++++++-------------------- 1 files changed, 14 insertions(+), 20 deletions(-) diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 9abec80..2b5a7f8 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -4,33 +4,27 @@ GIT URLS[[URLS]] One of the following notations can be used to name the remote repository: -=============================================================== -- 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 + 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 -=============================================================== + host.xz:/path/to/repo.git/ + host.xz:~user/path/to/repo.git/ + host.xz:path/to/repo.git To sync with a local directory, use: -=============================================================== -- /path/to/repo.git/ -=============================================================== + /path/to/repo.git/ REMOTES ------- -- 1.4.1.g2fca1 ``` ## Junio C Hamano, 2006-07-13 04:58 Subject: Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation Message-ID: <7vpsgaw16d.fsf@assigned-by-dhcp.cox.net> URL: https://gitlist.dev/e/7vpsgaw16d.fsf%40assigned-by-dhcp.cox.net In-Reply-To: <11527413212127-git-send-email-alp@atoker.com> ``` Alp Toker writes: > Commit c3f17061be95de3498449a548e93883aebff23d6 was causing warnings > during doc generation due to bad asciidoc markup. > > This resulted in "ssh://[user@]host.xz/path/to/repo.git/" being rendered > as "host.xz/path/to/repo.git/" in the man pages and html output. I wonder if this is with less formatting impact then. diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 9abec80..93378d2 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -10,9 +10,9 @@ 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://+++[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 ``` ## Alp Toker, 2006-07-13 05:48 Subject: Re: [PATCH] Documentation: Fix ssh:// URLs in generated documentation Message-ID: <44B5DECA.8040401@atoker.com> URL: https://gitlist.dev/e/44B5DECA.8040401%40atoker.com In-Reply-To: <7vpsgaw16d.fsf@assigned-by-dhcp.cox.net> ``` Junio C Hamano wrote: > I wonder if this is with less formatting impact then. > > diff --git a/Documentation/urls.txt b/Documentation/urls.txt > index 9abec80..93378d2 100644 > --- a/Documentation/urls.txt > +++ b/Documentation/urls.txt > @@ -10,9 +10,9 @@ 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://+++[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 Your call. I almost went that way but decided the more invasive patch left the source a bit more readable as it didn't need escaping. As long as the output gets fixed, nobody will be losing sleep over this one. ```