| Message ID | 20240129115008.674248-6-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qmp: Documentation cleanups | expand |
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com> On Mon, Jan 29, 2024 at 1:50 PM Markus Armbruster <armbru@redhat.com> wrote: > 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> > --- > qga/qapi-schema.json | 18 +++++++++--------- > 1 file 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 > -- > 2.43.0 > >
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
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> --- qga/qapi-schema.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)