diff mbox series

[2/2] rtla: Minor fix to grammar in README.txt

Message ID 20220402043939.6962-2-jkacur@redhat.com
State New
Headers show
Series [1/2] rtla: Don't overwrite existing directory mode | expand

Commit Message

John Kacur April 2, 2022, 4:39 a.m. UTC
"The rtla" doesn't make sense, change it to "The rtla tool"
This is better than removing the word "The" since some packaging tools
need the description to start with a capital letter.

Signed-off-by: John Kacur <jkacur@redhat.com>
---
 tools/tracing/rtla/README.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Daniel Bristot de Oliveira April 8, 2022, 1:10 p.m. UTC | #1
On 4/2/22 06:39, John Kacur wrote:
> "The rtla" doesn't make sense, change it to "The rtla tool"
> This is better than removing the word "The" since some packaging tools
> need the description to start with a capital letter.
> 
> Signed-off-by: John Kacur <jkacur@redhat.com>
> ---
>  tools/tracing/rtla/README.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt
> index 6c88446f7e74..3b809eeff5f9 100644
> --- a/tools/tracing/rtla/README.txt
> +++ b/tools/tracing/rtla/README.txt
> @@ -1,6 +1,6 @@
>  RTLA: Real-Time Linux Analysis tools
>  
> -The rtla is a meta-tool that includes a set of commands that
> +The rtla tool is a meta-tool that includes a set of commands that

I do not like bike-shedding but 'the rtla tool is a meta-tool" sounds repetitive.

Does:

The rtla meta-tool includes a set of commands...

sound good for you?

-- Daniel
John Kacur April 8, 2022, 1:49 p.m. UTC | #2
On Fri, 8 Apr 2022, Daniel Bristot de Oliveira wrote:

> On 4/2/22 06:39, John Kacur wrote:
> > "The rtla" doesn't make sense, change it to "The rtla tool"
> > This is better than removing the word "The" since some packaging tools
> > need the description to start with a capital letter.
> > 
> > Signed-off-by: John Kacur <jkacur@redhat.com>
> > ---
> >  tools/tracing/rtla/README.txt | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt
> > index 6c88446f7e74..3b809eeff5f9 100644
> > --- a/tools/tracing/rtla/README.txt
> > +++ b/tools/tracing/rtla/README.txt
> > @@ -1,6 +1,6 @@
> >  RTLA: Real-Time Linux Analysis tools
> >  
> > -The rtla is a meta-tool that includes a set of commands that
> > +The rtla tool is a meta-tool that includes a set of commands that
> 
> I do not like bike-shedding but 'the rtla tool is a meta-tool" sounds repetitive.
> 
> Does:
> 
> The rtla meta-tool includes a set of commands...
> 
> sound good for you?
> 
> -- Daniel
> 
> 

Perfect
Daniel Bristot de Oliveira April 8, 2022, 2:11 p.m. UTC | #3
>>> -The rtla is a meta-tool that includes a set of commands that
>>> +The rtla tool is a meta-tool that includes a set of commands that
>> I do not like bike-shedding but 'the rtla tool is a meta-tool" sounds repetitive.
>>
>> Does:
>>
>> The rtla meta-tool includes a set of commands...
>>
>> sound good for you?
>>
>> -- Daniel
>>
>>
> Perfect
> 

Would you mind re-sending this patch?

You will also need to adjust the paragraph alignment as the first line is
shorter now ...
-- Daniel
diff mbox series

Patch

diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt
index 6c88446f7e74..3b809eeff5f9 100644
--- a/tools/tracing/rtla/README.txt
+++ b/tools/tracing/rtla/README.txt
@@ -1,6 +1,6 @@ 
 RTLA: Real-Time Linux Analysis tools
 
-The rtla is a meta-tool that includes a set of commands that
+The rtla tool is a meta-tool that includes a set of commands that
 aims to analyze the real-time properties of Linux. But, instead of
 testing Linux as a black box, rtla leverages kernel tracing
 capabilities to provide precise information about the properties