Re: [PATCH] Documentation: admin-guide: Adding sysrq-key combination for System Z/S390 arch.

[Jonathan Corbet <corbet@lwn.net>]

On Tue, 3 Jul 2018 23:04:47 +0530
Prashant Dhamdhere <pdhamdhe@redhat.com> wrote:

> Signed-off-by: Prashant Dhamdhere <pdhamdhe@redhat.com>

Thanks for working to improve the docs.  I do have some requests, though,
starting with: please provide a changelog for all of your patches.

> ---
>  Documentation/admin-guide/sysrq.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/admin-guide/sysrq.rst
> b/Documentation/admin-guide/sysrq.rst
> index 7b9035c01a2e..21deab9e542c 100644
> --- a/Documentation/admin-guide/sysrq.rst
> +++ b/Documentation/admin-guide/sysrq.rst
> @@ -68,6 +68,11 @@ On PowerPC
>         Press :kbd:`ALT - Print Screen` (or :kbd:`F13`) - :kbd:`<command
> key>`,  
>          :kbd:`Print Screen` (or :kbd:`F13`) - :kbd:`<command key>` may
> suffice.
> 
> +On System Z - Press 'CTRL-O-<command key>' on the hvc0 console.'CTRL-O'
> means
> +              pressing 'O' (not zero) while holding down the 'CTRL' key.

This patch has been line-wrapped by your mailer.  Please email a patch to
yourself and be sure that you can apply it before trying again.  You can
check Documentation/process/email-clients.rst for information on taming
email clients.

Also, please put spaces after periods.

Readers of this document will know what "CTRL-O" (or "^O") means, that does
not need to be spelled out.

> For
> +              3270 console or line-mode HMC console: Pass '^-<command key>'
> +              Here, '^-' means cap and dash characters.

This, though, is rather less clear.  What does "pass" mean in this context?
We all know what ^ and - are.  But what do we do with them?  Just type them
in sequence?  If so, please say so.  Do they have to be after a newline or
anything like that?

> +
>  On other
>         If you know of the key combos for other architectures, please
>          let me know so I can add them to this section.

Also, please format the docs with "make htmldocs" or the like and make sure
the right thing happens with your changes.

Thanks,

jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html