diff mbox

[maintainers-tools] dim: Clarify how to proceed when adding drm-xxx remotes

Message ID 1488285383-9111-1-git-send-email-boris.brezillon@free-electrons.com (mailing list archive)
State New, archived
Headers show

Commit Message

Boris BREZILLON Feb. 28, 2017, 12:36 p.m. UTC
Some people are specifying the username directly in the url with the
following syntax: ssh://<username>@git.freedesktop.org/git/<repo>, but
dim expects something like ssh://git.freedesktop.org/git/<repo>.

Update the documentation to document how to assign a default username
when connecting to git.freedesktop.org through SSH.

Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com>
---
 dim.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Daniel Stone Feb. 28, 2017, 12:50 p.m. UTC | #1
Hi,

On 28 February 2017 at 12:36, Boris Brezillon
<boris.brezillon@free-electrons.com> wrote:
> @@ -54,6 +54,13 @@ This will also check out the latest maintainer-tools branches, so please replace
>  the dim you just downloaded with a symlink after this step. And by the way, if
>  you have improvements for dim, please submit them to intel-gfx.
>
> +If you have a freedesktop.org account and plan to push things on one of the
> +drm-xxx repos, you should use the ssh://git.freedesktop.org/git/drm-xxx urls
> +when adding a remote and, if it's not already done, you should add new entry in
> +~/.ssh/config:
> +
> +    $ printf '\nHost git.freedesktop.org\n\tUser <username>' >> ~/.ssh/config
> +

Bikeshed time:

You should always use the ssh://git.freedesktop.org/git/drm-xxx URLs for your
git remote entries. If you need to specify a username, rather than specifying it
in the remote URL, you can modify ~/.ssh/config:

    $ printf '\nHost git.freedesktop.org\n\tUser <username>' >> ~/.ssh/config

with that, it's:
Reviewed-by: Daniel Stone <daniels@collabora.com>

Cheers,
Daniel
Daniel Vetter Feb. 28, 2017, 1:28 p.m. UTC | #2
On Tue, Feb 28, 2017 at 12:50:57PM +0000, Daniel Stone wrote:
> Hi,
> 
> On 28 February 2017 at 12:36, Boris Brezillon
> <boris.brezillon@free-electrons.com> wrote:
> > @@ -54,6 +54,13 @@ This will also check out the latest maintainer-tools branches, so please replace
> >  the dim you just downloaded with a symlink after this step. And by the way, if
> >  you have improvements for dim, please submit them to intel-gfx.
> >
> > +If you have a freedesktop.org account and plan to push things on one of the
> > +drm-xxx repos, you should use the ssh://git.freedesktop.org/git/drm-xxx urls
> > +when adding a remote and, if it's not already done, you should add new entry in
> > +~/.ssh/config:
> > +
> > +    $ printf '\nHost git.freedesktop.org\n\tUser <username>' >> ~/.ssh/config
> > +
> 
> Bikeshed time:
> 
> You should always use the ssh://git.freedesktop.org/git/drm-xxx URLs for your
> git remote entries. If you need to specify a username, rather than specifying it
> in the remote URL, you can modify ~/.ssh/config:

I also converted to :: for the markup.
> 
>     $ printf '\nHost git.freedesktop.org\n\tUser <username>' >> ~/.ssh/config
> 
> with that, it's:
> Reviewed-by: Daniel Stone <daniels@collabora.com>

Applied, thanks.
-Daniel
diff mbox

Patch

diff --git a/dim.rst b/dim.rst
index 911b4666b4aa..bbb1d15a6d4b 100644
--- a/dim.rst
+++ b/dim.rst
@@ -54,6 +54,13 @@  This will also check out the latest maintainer-tools branches, so please replace
 the dim you just downloaded with a symlink after this step. And by the way, if
 you have improvements for dim, please submit them to intel-gfx.
 
+If you have a freedesktop.org account and plan to push things on one of the
+drm-xxx repos, you should use the ssh://git.freedesktop.org/git/drm-xxx urls
+when adding a remote and, if it's not already done, you should add new entry in
+~/.ssh/config:
+
+    $ printf '\nHost git.freedesktop.org\n\tUser <username>' >> ~/.ssh/config
+
 You should now have a main repository for patch application. The directory
 corresponding to this repository is defined by DIM_DRM_INTEL in your .dimrc.
 You should also have directories called maintainer-tools, drm-tip (for