[Skiboot] [PATCH V3] doc/opal-api : Document opal-api's related to errorlog

[Mukesh Ojha]

Hi Vasant,

Thanks for the review.
Your comments have been taken care in V4 of this patch.

Regards,
Mukesh

On Friday 15 July 2016 12:22 PM, Vasant Hegde wrote:
> On 07/13/2016 03:10 PM, Mukesh Ojha wrote:
>> It document opal-api's related to errorlog.
>> OPAL_ELOG_READ          71
>> OPAL_ELOG_WRITE         72(UNUSED)
>> OPAL_ELOG_ACK           73
>> OPAL_ELOG_RESEND        74
>> OPAL_ELOG_SIZE          75
>>
>> Signed-off-by: Mukesh Ojha <mukesh02 at linux.vnet.ibm.com>
>> ---
>> Changes in V3:
>>   - It takes care of the comment made by Vasant.
>>
>> Changes in V2:
>>   - As per the discussion with Stewart offline, This patch adds examples
>>     and the usage of the api's from the host kernel.
>>
>>   doc/opal-api/opal-elog-71-72-73-74-75.txt | 118 
>> ++++++++++++++++++++++++++++++
>>   1 file changed, 118 insertions(+)
>>   create mode 100644 doc/opal-api/opal-elog-71-72-73-74-75.txt
>>
>> diff --git a/doc/opal-api/opal-elog-71-72-73-74-75.txt 
>> b/doc/opal-api/opal-elog-71-72-73-74-75.txt
>> new file mode 100644
>> index 0000000..460efc0
>> --- /dev/null
>> +++ b/doc/opal-api/opal-elog-71-72-73-74-75.txt
>> @@ -0,0 +1,118 @@
>> +Error logging Generic API's description:
>> +=======================================
>> +
>> +There are five generic OPAL calls from host to OPAL on error log:
>
> "generic" is redundant here.
>
> also you may want to document type parameter in OPAL_ELOG_SIZE call.
>
> -Vasant
>