Code review comment for lp:~adam-delvecchio/bzr/662448-sshkey-doc

Revision history for this message
Martin Pool (mbp) wrote :

Thanks!

The ReST markup is a bit wrong: in the wiki the headings have bars next to them whereas in rest they need an underline of the same length as the heading. Example terminal output or files should have a :: on the preceding line; inline examples should be in ``double backticks``. See http://docutils.sourceforge.net/docs/user/rst/quickref.html

Perhaps there are a few more points to make in the introduction:

 * you can authenticate over ssh by a key pair or by a password (or potentially by other mechanisms); the server chooses what it will accept
 * an ssh key is an assymetric key: there is a 'public' part you put on the server and a private part you keep

I think that using a master connection, while really useful to document, is not normally what people want and describing it first may cause counfusion?

+
+In some cases, ssh may refuse to work if your public key is in your ~/.ssh directory.
+
+ mv ~/.ssh/id_rsa.pub ~/id_rsa.pub
+should fix the problem.

I guess that's on the wiki page but I can't imagine why it would work and it seems like a kind of random suggestion.

s/exxe/exe

review: Needs Fixing

« Back to merge proposal