diff options
| author | Markus Armbruster <armbru@redhat.com> | 2024-01-29 12:50:08 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-02-03 09:20:33 +0100 |
| commit | 3424ed6caf9759eb57405d965537fd5f3d70026b (patch) | |
| tree | b7a5f80c719d24ab9407b268ac63cd98149d5789 /qga | |
| parent | d6a5ca3acfcbc164bbb15a0690d997212b29d6c3 (diff) | |
qga/qapi-schema: Move command description right after command name
Documentation of commands guest-ssh-get-authorized-keys,
guest-ssh-add-authorized-keys, and guest-ssh-remove-authorized-keys
describes the command's purpose after its arguments. Everywhere else,
we do it the other way round. Move it for consistency.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240129115008.674248-6-armbru@redhat.com>
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>
Diffstat (limited to 'qga')
| -rw-r--r-- | qga/qapi-schema.json | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 876e2a8ea8..50b0a558c7 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -1565,11 +1565,11 @@ ## # @guest-ssh-get-authorized-keys: # -# @username: the user account to add the authorized keys -# # Return the public keys from user .ssh/authorized_keys on Unix # systems (not implemented for other systems). # +# @username: the user account to add the authorized keys +# # Returns: @GuestAuthorizedKeys # # Since: 5.2 @@ -1582,6 +1582,9 @@ ## # @guest-ssh-add-authorized-keys: # +# Append public keys to user .ssh/authorized_keys on Unix systems (not +# implemented for other systems). +# # @username: the user account to add the authorized keys # # @keys: the public keys to add (in OpenSSH/sshd(8) authorized_keys @@ -1589,9 +1592,6 @@ # # @reset: ignore the existing content, set it with the given keys only # -# Append public keys to user .ssh/authorized_keys on Unix systems (not -# implemented for other systems). -# # Returns: Nothing on success. # # Since: 5.2 @@ -1603,15 +1603,15 @@ ## # @guest-ssh-remove-authorized-keys: # +# Remove public keys from the user .ssh/authorized_keys on Unix +# systems (not implemented for other systems). It's not an error if +# the key is already missing. +# # @username: the user account to remove the authorized keys # # @keys: the public keys to remove (in OpenSSH/sshd(8) authorized_keys # format) # -# Remove public keys from the user .ssh/authorized_keys on Unix -# systems (not implemented for other systems). It's not an error if -# the key is already missing. -# # Returns: Nothing on success. # # Since: 5.2 |