diff mbox

[07/24,v4] manual: document dependencies on atomic operations

Message ID 4061c3ce3e322eed4f6a91e635133d0e0dd2e2f4.1408279142.git.yann.morin.1998@free.fr
State Changes Requested
Headers show

Commit Message

Yann E. MORIN Aug. 17, 2014, 12:48 p.m. UTC
From: Anton Kolesov <anton.kolesov@synopsys.com>

Add atomic operations to the list of generic dependencies.

Since this is an architecture option, there is no comment string to be
added.

Signed-off-by: Anton Kolesov <Anton.Kolesov@synopsys.com>
[yann.morin.1998@free.fr: use the new arch-option; remove comment string]
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
---
 docs/manual/adding-packages-directory.txt | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Thomas De Schampheleire Aug. 17, 2014, 1:01 p.m. UTC | #1
"Yann E. MORIN" <yann.morin.1998@free.fr> schreef:
>From: Anton Kolesov <anton.kolesov@synopsys.com>
>
>Add atomic operations to the list of generic dependencies.
>
>Since this is an architecture option, there is no comment string to be
>added.
>
>Signed-off-by: Anton Kolesov <Anton.Kolesov@synopsys.com>
>[yann.morin.1998@free.fr: use the new arch-option; remove comment string]
>Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
>---
> docs/manual/adding-packages-directory.txt | 4 ++++
> 1 file changed, 4 insertions(+)
>
>diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
>index 93e6a3e..40a81d5 100644
>--- a/docs/manual/adding-packages-directory.txt
>+++ b/docs/manual/adding-packages-directory.txt
>@@ -219,6 +219,10 @@ use in the comment.
> ** Dependency symbol: +BR2_USE_MMU+
> ** Comment string: no comment to be added
> 
>+* Atomic operations
>+** Dependency symbol: +BR2_ARCH_HAS_ATOMICS+
>+** Comment string: no comment to be added
>+

Should we provide a brief explanation, reference, or
 name of these functions to make it a bit clearer what
is meant with 'atomic operations'?
Yann E. MORIN Aug. 17, 2014, 1:15 p.m. UTC | #2
Thomas, All,

On 2014-08-17 15:01 +0200, Thomas De Schampheleire spake thusly:
> "Yann E. MORIN" <yann.morin.1998@free.fr> schreef:
> >From: Anton Kolesov <anton.kolesov@synopsys.com>
> >
> >Add atomic operations to the list of generic dependencies.
> >
> >Since this is an architecture option, there is no comment string to be
> >added.
> >
> >Signed-off-by: Anton Kolesov <Anton.Kolesov@synopsys.com>
> >[yann.morin.1998@free.fr: use the new arch-option; remove comment string]
> >Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
> >---
> > docs/manual/adding-packages-directory.txt | 4 ++++
> > 1 file changed, 4 insertions(+)
> >
> >diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
> >index 93e6a3e..40a81d5 100644
> >--- a/docs/manual/adding-packages-directory.txt
> >+++ b/docs/manual/adding-packages-directory.txt
> >@@ -219,6 +219,10 @@ use in the comment.
> > ** Dependency symbol: +BR2_USE_MMU+
> > ** Comment string: no comment to be added
> > 
> >+* Atomic operations
> >+** Dependency symbol: +BR2_ARCH_HAS_ATOMICS+
> >+** Comment string: no comment to be added
> >+
> 
> Should we provide a brief explanation, reference, or
>  name of these functions to make it a bit clearer what
> is meant with 'atomic operations'?

Well, the atomics are all named differently in different architectures.

For example, armv6+ has LDREX and STREX (amon others):
    http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dht0008a/ch01s02s01.html

While on x86, I don't think there are corresponding instructions, but
you can prefix some intructions with the LOCK prefix to achieve a
similar result.

So, I would not know what to put in here. Also, we do not explain what
the other options are (like MMU, for example). Why would we do that for
this specific option, and not others?

Regards,
Yann E. MORIN.
Thomas De Schampheleire Aug. 17, 2014, 1:25 p.m. UTC | #3
"Yann E. MORIN" <yann.morin.1998@free.fr> schreef:
>Thomas, All,
>
>On 2014-08-17 15:01 +0200, Thomas De Schampheleire spake thusly:
>> "Yann E. MORIN" <yann.morin.1998@free.fr> schreef:
>> >From: Anton Kolesov <anton.kolesov@synopsys.com>
>> >
>> >Add atomic operations to the list of generic dependencies.
>> >
>> >Since this is an architecture option, there is no comment string to be
>> >added.
>> >
>> >Signed-off-by: Anton Kolesov <Anton.Kolesov@synopsys.com>
>> >[yann.morin.1998@free.fr: use the new arch-option; remove comment string]
>> >Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
>> >---
>> > docs/manual/adding-packages-directory.txt | 4 ++++
>> > 1 file changed, 4 insertions(+)
>> >
>> >diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
>> >index 93e6a3e..40a81d5 100644
>> >--- a/docs/manual/adding-packages-directory.txt
>> >+++ b/docs/manual/adding-packages-directory.txt
>> >@@ -219,6 +219,10 @@ use in the comment.
>> > ** Dependency symbol: +BR2_USE_MMU+
>> > ** Comment string: no comment to be added
>> > 
>> >+* Atomic operations
>> >+** Dependency symbol: +BR2_ARCH_HAS_ATOMICS+
>> >+** Comment string: no comment to be added
>> >+
>> 
>> Should we provide a brief explanation, reference, or
>>  name of these functions to make it a bit clearer what
>> is meant with 'atomic operations'?
>
>Well, the atomics are all named differently in different architectures.
>
>For example, armv6+ has LDREX and STREX (amon others):
>    http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dht0008a/ch01s02s01.html
>
>While on x86, I don't think there are corresponding instructions, but
>you can prefix some intructions with the LOCK prefix to achieve a
>similar result.
>
>So, I would not know what to put in here. Also, we do not explain what
>the other options are (like MMU, for example). Why would we do that for
>this specific option, and not others?


Because MMU is a widely known acronym for anyone in the embedded world, but 'atomics' or 'atomic operations' is a much more general term that is less obvious, IMHO.

Maybe the description can clarify that we're talking about a dependency on _CPU_ atomic _instructions_?
Yann E. MORIN Aug. 17, 2014, 2:20 p.m. UTC | #4
Thomas, All,

On 2014-08-17 15:25 +0200, Thomas De Schampheleire spake thusly:
> "Yann E. MORIN" <yann.morin.1998@free.fr> schreef:
> >Thomas, All,
> >
> >On 2014-08-17 15:01 +0200, Thomas De Schampheleire spake thusly:
> >> "Yann E. MORIN" <yann.morin.1998@free.fr> schreef:
> >> >From: Anton Kolesov <anton.kolesov@synopsys.com>
> >> >
> >> >Add atomic operations to the list of generic dependencies.
> >> >
> >> >Since this is an architecture option, there is no comment string to be
> >> >added.
> >> >
> >> >Signed-off-by: Anton Kolesov <Anton.Kolesov@synopsys.com>
> >> >[yann.morin.1998@free.fr: use the new arch-option; remove comment string]
> >> >Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
> >> >---
> >> > docs/manual/adding-packages-directory.txt | 4 ++++
> >> > 1 file changed, 4 insertions(+)
> >> >
> >> >diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
> >> >index 93e6a3e..40a81d5 100644
> >> >--- a/docs/manual/adding-packages-directory.txt
> >> >+++ b/docs/manual/adding-packages-directory.txt
> >> >@@ -219,6 +219,10 @@ use in the comment.
> >> > ** Dependency symbol: +BR2_USE_MMU+
> >> > ** Comment string: no comment to be added
> >> > 
> >> >+* Atomic operations
> >> >+** Dependency symbol: +BR2_ARCH_HAS_ATOMICS+
> >> >+** Comment string: no comment to be added
> >> >+
> >> 
> >> Should we provide a brief explanation, reference, or
> >>  name of these functions to make it a bit clearer what
> >> is meant with 'atomic operations'?
> >
> >Well, the atomics are all named differently in different architectures.
> >
> >For example, armv6+ has LDREX and STREX (amon others):
> >    http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dht0008a/ch01s02s01.html
> >
> >While on x86, I don't think there are corresponding instructions, but
> >you can prefix some intructions with the LOCK prefix to achieve a
> >similar result.
> >
> >So, I would not know what to put in here. Also, we do not explain what
> >the other options are (like MMU, for example). Why would we do that for
> >this specific option, and not others?
> 
> Because MMU is a widely known acronym for anyone in the embedded world,
> but 'atomics' or 'atomic operations' is a much more general term that
> is less obvious, IMHO.

Weird how different people, even from the same field, would consider one
thing as a fundamentals and not some other thing, or the opposite. :-)

> Maybe the description can clarify that we're talking about a dependency
> on _CPU_ atomic _instructions_?

OK, let's strike a deal: I keep the option name as-is (I like it), but I
add a bit of explanations in the manual. Deal? ;-)

Regards,
Yann E. MORIN.
diff mbox

Patch

diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index 93e6a3e..40a81d5 100644
--- a/docs/manual/adding-packages-directory.txt
+++ b/docs/manual/adding-packages-directory.txt
@@ -219,6 +219,10 @@  use in the comment.
 ** Dependency symbol: +BR2_USE_MMU+
 ** Comment string: no comment to be added
 
+* Atomic operations
+** Dependency symbol: +BR2_ARCH_HAS_ATOMICS+
+** Comment string: no comment to be added
+
 * Kernel headers
 ** Dependency symbol: +BR2_TOOLCHAIN_HEADERS_AT_LEAST_X_Y+, (replace
    +X_Y+ with the proper version, see +toolchain/toolchain-common.in+)