Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 194569 - keychain-guide - Typo and one example is missing
Summary: keychain-guide - Typo and one example is missing
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: Other documents (show other bugs)
Hardware: All Linux
: High minor (vote)
Assignee: Docs Team
URL: http://www.gentoo.org/doc/en/keychain...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-10-03 03:56 UTC by Kun Xi
Modified: 2007-10-04 15:56 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Kun Xi 2007-10-03 03:56:45 UTC
--- keychain-guide.xml  2007-04-29 12:41:28.000000000 -0400
+++ keychain-guide-r1.xml       2007-10-02 23:40:03.000000000 -0400
@@ -199,7 +199,7 @@
 </pre>

 <p>
-It would be nice to know how to shut down ssh-agent in case you needed to,
+It would be nice to know how to shut down ssh-agent in case you need to,
 right?
 </p>

@@ -278,7 +278,7 @@
 <path>/usr/kde/${KDE_VERSION}/shutdown/agent-shutdown.sh</path>, which is
 executed during KDE's shutdown, where ${KDE_VERSION} corresponds to the first
 two version components of your KDE installation. For example, if you are using
-KDE 3.5.1, here is how you could edit those files:
+KDE 3.5.1, ${KDE_VERSION} is 3.5. Here is how you could edit those files:
 </p>

 <pre caption="Editing /usr/kde/3.5/env/agent-startup.sh">

And another optional improvement:

SSH 2 is commonly used, now we may need to add the public key to .ssh/authorized_keys2

It is worthy mentioning how to import a public key from SSH Communications Security.


Reproducible: Always
Comment 1 Jan Kundrát (RETIRED) gentoo-dev 2007-10-03 23:37:56 UTC
(In reply to comment #0)
> SSH 2 is commonly used, now we may need to add the public key to
> .ssh/authorized_keys2

False, see your ssh(1) manpage.

> It is worthy mentioning how to import a public key from SSH Communications
> Security.

Could you please clarify?
Comment 2 nm (RETIRED) gentoo-dev 2007-10-04 01:28:32 UTC
Only the first typo is actually a typo; I fixed it. s/needed/need

The second is not a typo; re-read the paragraph: "corresponds to the first
 two version components of your KDE installation". That's plain as daylight.

And no to the third (the commercial vendor http://www.ssh.com/); this guide is about keychain and ssh-agent, not about basics such as importing public keys. For that, see your manpage. Plus, their SSH product(s) is/are hard-masked, so we don't need to cover them.
Comment 3 Shyam Mani (RETIRED) gentoo-dev 2007-10-04 03:33:26 UTC
IMHO needed to is fine as well. Past continous? It wasn't really a typo. As for KDE, yeah...would be nicer to drop in an example but I think the current is okay too.

I was going to fix this until work came up :p
Comment 4 Kun Xi 2007-10-04 15:56:19 UTC
(In reply to comment #2)
> Only the first typo is actually a typo; I fixed it. s/needed/need
> 
> The second is not a typo; re-read the paragraph: "corresponds to the first
>  two version components of your KDE installation". That's plain as daylight.
> 

Yes, it is quite straightforward, first, 
"where ${KDE_VERSION} corresponds to the first two version components of your KDE installation."
then,for example, you show the path 
"Editing /usr/kde/3.5/env/agent-startup.sh"

The example happens to be inside the caption of the example, I am afraid many users may oversee this. That is the reason I propose to add it explicitly. 

But anyway, this is quite trivial.