Update the sentence in livepatch.rst to: "Functions are there for a reason. Take some input parameters, acquire or release locks, read, process, and write some data in a defined way."

Signed-off-by: Attreyee Mukherjee <tintinm2017@gmail.com>
---
 Documentation/livepatch/livepatch.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/livepatch/livepatch.rst b/Documentation/livepatch/livepatch.rst
index 68e3651e8af9..acb90164929e 100644
--- a/Documentation/livepatch/livepatch.rst
+++ b/Documentation/livepatch/livepatch.rst
@@ -50,7 +50,7 @@ some limitations, see below.
 3. Consistency model
 ====================
 
-Functions are there for a reason. They take some input parameters, get or
+Functions are there for a reason. They take some input parameters, acquire or
 release locks, read, process, and even write some data in a defined way,
 have return values. In other words, each function has a defined semantic.
 
-- 
2.34.1

attreyee-muk <tintinm2017@gmail.com> writes:

> Update the sentence in livepatch.rst to: "Functions are there for a reason. Take some input parameters, acquire or release locks, read, process, and write some data in a defined way."
>
> Signed-off-by: Attreyee Mukherjee <tintinm2017@gmail.com>
> ---
>  Documentation/livepatch/livepatch.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

So this is a classic example of saying what you have done, but not why.
What makes this a change that we want?

Also, please wrap your changelogs to a reasonable line length.

Thanks,

jon

On Sat, Dec 23, 2023 at 03:08:54PM -0700, Jonathan Corbet wrote:
> attreyee-muk <tintinm2017@gmail.com> writes:
> 
> > Update the sentence in livepatch.rst to: "Functions are there for a reason. Take some input parameters, acquire or release locks, read, process, and write some data in a defined way."
> >
> > Signed-off-by: Attreyee Mukherjee <tintinm2017@gmail.com>
> > ---
> >  Documentation/livepatch/livepatch.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> So this is a classic example of saying what you have done, but not why.
> What makes this a change that we want?

I think what he intended was "The word 'get' is not the correct antonym to
'release' in the context of locking. Replace it with 'acquire'".

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

Hello maintainers,

I wanted to ask if this patch of mine is accepted as of now.

Thank you
Attreyee Mukherjee


On Tue, 26 Dec 2023 at 10:22, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> On Sat, Dec 23, 2023 at 03:08:54PM -0700, Jonathan Corbet wrote:
> > attreyee-muk <tintinm2017@gmail.com> writes:
> >
> > > Update the sentence in livepatch.rst to: "Functions are there for a reason. Take some input parameters, acquire or release locks, read, process, and write some data in a defined way."
> > >
> > > Signed-off-by: Attreyee Mukherjee <tintinm2017@gmail.com>
> > > ---
> > >  Documentation/livepatch/livepatch.rst | 2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > So this is a classic example of saying what you have done, but not why.
> > What makes this a change that we want?
>
> I think what he intended was "The word 'get' is not the correct antonym to
> 'release' in the context of locking. Replace it with 'acquire'".
>
> Thanks.
>
> --
> An old man doll... just what I always wanted! - Clara