diff mbox series

[i-g-t,1/4] intel_gpu_top: Fix man page formatting

Message ID 20230112174730.1101192-2-tvrtko.ursulin@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series Some intel_gpu_top tweaks | expand

Commit Message

Tvrtko Ursulin Jan. 12, 2023, 5:47 p.m. UTC
From: Tvrtko Ursulin <tvrtko.ursulin@intel.com>

New lines are not respected when rst2man generates the page so try to work
around that by followin advice from the Internet.

Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
---
 man/intel_gpu_top.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

Comments

Kamil Konieczny Jan. 26, 2023, 3:39 p.m. UTC | #1
On 2023-01-12 at 17:47:27 +0000, Tvrtko Ursulin wrote:
> From: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
> 
> New lines are not respected when rst2man generates the page so try to work
> around that by followin advice from the Internet.
> 
> Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com>

Reviewed-by: Kamil Konieczny <kamil.konieczny@linux.intel.com>

> ---
>  man/intel_gpu_top.rst | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
> 
> diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst
> index 748c7740c800..b0c95446a011 100644
> --- a/man/intel_gpu_top.rst
> +++ b/man/intel_gpu_top.rst
> @@ -53,13 +53,14 @@ RUNTIME CONTROL
>  
>  Supported keys:
>  
> -    'q'    Exit from the tool.
> -    'h'    Show interactive help.
> -    '1'    Toggle between aggregated engine class and physical engine mode.
> -    'n'    Toggle display of numeric client busyness overlay.
> -    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
> -    'i'    Toggle display of clients which used no GPU time.
> -    'H'    Toggle between per PID aggregation and individual clients.
> +|
> +|    'q'    Exit from the tool.
> +|    'h'    Show interactive help.
> +|    '1'    Toggle between aggregated engine class and physical engine mode.
> +|    'n'    Toggle display of numeric client busyness overlay.
> +|    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
> +|    'i'    Toggle display of clients which used no GPU time.
> +|    'H'    Toggle between per PID aggregation and individual clients.
>  
>  DEVICE SELECTION
>  ================
> -- 
> 2.34.1
>
Tvrtko Ursulin Jan. 26, 2023, 4:09 p.m. UTC | #2
On 26/01/2023 15:39, Kamil Konieczny wrote:
> On 2023-01-12 at 17:47:27 +0000, Tvrtko Ursulin wrote:
>> From: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
>>
>> New lines are not respected when rst2man generates the page so try to work
>> around that by followin advice from the Internet.
>>
>> Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
> 
> Reviewed-by: Kamil Konieczny <kamil.konieczny@linux.intel.com>

Thanks! Later I noticed there is one more thing which currently renders 
badly, this line:

   -o <file path | ->

Are you okay with re-review if I can fix that one too and respin?

Regards,

Tvrtko

>> ---
>>   man/intel_gpu_top.rst | 15 ++++++++-------
>>   1 file changed, 8 insertions(+), 7 deletions(-)
>>
>> diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst
>> index 748c7740c800..b0c95446a011 100644
>> --- a/man/intel_gpu_top.rst
>> +++ b/man/intel_gpu_top.rst
>> @@ -53,13 +53,14 @@ RUNTIME CONTROL
>>   
>>   Supported keys:
>>   
>> -    'q'    Exit from the tool.
>> -    'h'    Show interactive help.
>> -    '1'    Toggle between aggregated engine class and physical engine mode.
>> -    'n'    Toggle display of numeric client busyness overlay.
>> -    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
>> -    'i'    Toggle display of clients which used no GPU time.
>> -    'H'    Toggle between per PID aggregation and individual clients.
>> +|
>> +|    'q'    Exit from the tool.
>> +|    'h'    Show interactive help.
>> +|    '1'    Toggle between aggregated engine class and physical engine mode.
>> +|    'n'    Toggle display of numeric client busyness overlay.
>> +|    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
>> +|    'i'    Toggle display of clients which used no GPU time.
>> +|    'H'    Toggle between per PID aggregation and individual clients.
>>   
>>   DEVICE SELECTION
>>   ================
>> -- 
>> 2.34.1
>>
Kamil Konieczny Jan. 26, 2023, 5:08 p.m. UTC | #3
Hi,

On 2023-01-26 at 16:09:29 +0000, Tvrtko Ursulin wrote:
> 
> On 26/01/2023 15:39, Kamil Konieczny wrote:
> > On 2023-01-12 at 17:47:27 +0000, Tvrtko Ursulin wrote:
> > > From: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
> > > 
> > > New lines are not respected when rst2man generates the page so try to work
> > > around that by followin advice from the Internet.
> > > 
> > > Signed-off-by: Tvrtko Ursulin <tvrtko.ursulin@intel.com>
> > 
> > Reviewed-by: Kamil Konieczny <kamil.konieczny@linux.intel.com>
> 
> Thanks! Later I noticed there is one more thing which currently renders
> badly, this line:
> 
>   -o <file path | ->
> 
> Are you okay with re-review if I can fix that one too and respin?

Yes, no problem, I can review respin.

Regards,
Kamil

> 
> Regards,
> 
> Tvrtko
> 
> > > ---
> > >   man/intel_gpu_top.rst | 15 ++++++++-------
> > >   1 file changed, 8 insertions(+), 7 deletions(-)
> > > 
> > > diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst
> > > index 748c7740c800..b0c95446a011 100644
> > > --- a/man/intel_gpu_top.rst
> > > +++ b/man/intel_gpu_top.rst
> > > @@ -53,13 +53,14 @@ RUNTIME CONTROL
> > >   Supported keys:
> > > -    'q'    Exit from the tool.
> > > -    'h'    Show interactive help.
> > > -    '1'    Toggle between aggregated engine class and physical engine mode.
> > > -    'n'    Toggle display of numeric client busyness overlay.
> > > -    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
> > > -    'i'    Toggle display of clients which used no GPU time.
> > > -    'H'    Toggle between per PID aggregation and individual clients.
> > > +|
> > > +|    'q'    Exit from the tool.
> > > +|    'h'    Show interactive help.
> > > +|    '1'    Toggle between aggregated engine class and physical engine mode.
> > > +|    'n'    Toggle display of numeric client busyness overlay.
> > > +|    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
> > > +|    'i'    Toggle display of clients which used no GPU time.
> > > +|    'H'    Toggle between per PID aggregation and individual clients.
> > >   DEVICE SELECTION
> > >   ================
> > > -- 
> > > 2.34.1
> > >
diff mbox series

Patch

diff --git a/man/intel_gpu_top.rst b/man/intel_gpu_top.rst
index 748c7740c800..b0c95446a011 100644
--- a/man/intel_gpu_top.rst
+++ b/man/intel_gpu_top.rst
@@ -53,13 +53,14 @@  RUNTIME CONTROL
 
 Supported keys:
 
-    'q'    Exit from the tool.
-    'h'    Show interactive help.
-    '1'    Toggle between aggregated engine class and physical engine mode.
-    'n'    Toggle display of numeric client busyness overlay.
-    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
-    'i'    Toggle display of clients which used no GPU time.
-    'H'    Toggle between per PID aggregation and individual clients.
+|
+|    'q'    Exit from the tool.
+|    'h'    Show interactive help.
+|    '1'    Toggle between aggregated engine class and physical engine mode.
+|    'n'    Toggle display of numeric client busyness overlay.
+|    's'    Toggle between sort modes (runtime, total runtime, pid, client id).
+|    'i'    Toggle display of clients which used no GPU time.
+|    'H'    Toggle between per PID aggregation and individual clients.
 
 DEVICE SELECTION
 ================