[rtems commit] sparc/cpu.h: Add comments

[Gedare Bloom]

On Mon, Mar 18, 2013 at 2:14 PM, Joel Sherrill
<joel.sherrill at oarcorp.com> wrote:
> On 3/18/2013 1:05 PM, Gedare Bloom wrote:
>>
>> Why is your comment a question?
>
> Most of the CPU port comment blocks are questions about the parameter
> and a description of that parameter. This is followed by a port specific
> answer.
>
> I didn't know the best way to phrase the answer.  [And I wanted to get
> this patch off my microblaze branch.]
>
> I think Sebastian added this definition to every port with no comment
> block.  If you like, I can propagate the question to all ports with an
> answer like:
>
> The size of a pointer (e.g. void *) is always XXX bytes.
>
> OR
>
> The size of a pointer (e.g. void *) is varies based upon the multilib
> variant. For X and Y, it is NNN bytes. For all others, it is MMM bytes.
>
> Are those viable options?
>
Yes i think so. a question without an answer in a comment makes me
think something is not right.

> --joel
>
>
> On Mon, Mar 18, 2013 at 12:36 PM, Joel Sherrill <joel at rtems.org> wrote:
>>>
>>> Module:    rtems
>>> Branch:    master
>>> Commit:    af99ec255b904d1c04e52b994b49d613476829bb
>>> Changeset:
>>> http://git.rtems.org/rtems/commit/?id=af99ec255b904d1c04e52b994b49d613476829bb
>>>
>>> Author:    Joel Sherrill <joel.sherrill at oarcorp.com>
>>> Date:      Tue Mar 12 10:15:47 2013 -0500
>>>
>>> sparc/cpu.h: Add comments
>>>
>>> ---
>>>
>>>   cpukit/score/cpu/sparc/rtems/score/cpu.h |    3 +++
>>>   1 files changed, 3 insertions(+), 0 deletions(-)
>>>
>>> diff --git a/cpukit/score/cpu/sparc/rtems/score/cpu.h
>>> b/cpukit/score/cpu/sparc/rtems/score/cpu.h
>>> index 6102355..b95d411 100644
>>> --- a/cpukit/score/cpu/sparc/rtems/score/cpu.h
>>> +++ b/cpukit/score/cpu/sparc/rtems/score/cpu.h
>>> @@ -877,6 +877,9 @@ extern const CPU_Trap_table_entry
>>> _CPU_Trap_slot_template;
>>>    */
>>>   #define CPU_STACK_MINIMUM_SIZE  (1024*4)
>>>
>>> +/**
>>> + * What is the size of a pointer on this architecture?
>>> + */
>>>   #define CPU_SIZEOF_POINTER 4
>>>
>>>   /**
>>>
>>> _______________________________________________
>>> rtems-vc mailing list
>>> rtems-vc at rtems.org
>>> http://www.rtems.org/mailman/listinfo/rtems-vc
>>
>> _______________________________________________
>> rtems-devel mailing list
>> rtems-devel at rtems.org
>> http://www.rtems.org/mailman/listinfo/rtems-devel
>
>
>
> --
> Joel Sherrill, Ph.D.             Director of Research & Development
> joel.sherrill at OARcorp.com        On-Line Applications Research
> Ask me about RTEMS: a free RTOS  Huntsville AL 35805
> Support Available                (256) 722-9985
>