What's the best way to report TGI API document ambui?

[xjtu.yohuang]

Hi,

What's the best way to report problems on TGI APIs document? Should we open a new topic for each API issue?

Here is one example API that has ambiguous definition, an abstractionDefinition port can have several modes (onSlave/onMaster), and each port mode can have an initiative. Given the abstractionDefPortID, how can we tell if the initiative should be set to onMaster or onSlave?

F.7.6.23 setAbstractionDefPortModeInitiative
	Description: Set initiative with the given value for the given abstractionDefPort element 
	— Returns: status of type Boolean - Indicates call is successful (true) or not (false)
	— Input: abstractionDefPortID of type String - Handle to abstractionDefPort element
	— Input: initiative of type String - Logical port initiative

XML example from the spec:

<ipxact:port>
  <ipxact:transactional>
   <ipxact:onMaster>
     <!-- abstractionDefinition/transactionalPort -->
     <ipxact:presence>optional</ipxact:presence>
     <ipxact:initiative>provides</ipxact:initiative>
     <ipxact:kind>simple_socket</ipxact:kind>
     <ipxact:busWidth>8</ipxact:busWidth>
     <!-- LINK: protocol: see 6.12.8, Component transactional protocol/payload definition -->
     <ipxact:protocol>
       <ipxact:protocolType>tlm</ipxact:protocolType>
       <ipxact:payload>
         <ipxact:name>tlm2</ipxact:name>
         <ipxact:type>generic</ipxact:type>
       </ipxact:payload>
     </ipxact:protocol>
   </ipxact:onMaster>
   <ipxact:onSlave>
     <ipxact:initiative>requires</ipxact:initiative>
     <ipxact:kind>simple_socket</ipxact:kind>
     <ipxact:protocol>
       <ipxact:protocolType>tlm</ipxact:protocolType>
       <ipxact:payload>
         <ipxact:name>tlm2</ipxact:name>
         <ipxact:type>generic</ipxact:type>
       </ipxact:payload>
   	 </ipxact:protocol>
   </ipxact:onSlave>
 </ipxact:transactional>
</ipxact:port>

 

thanks,

Yohuang

[kock]

Hi Yohang,

Thanks for your interest in TGI. You can mail the IP-XACT Working Group members directly using  ip-xact@lists.accellera.org to report issues or, if you prefer, you can list them in this forum. As mentioned earlier, the WG is preparing an TGI Application Note which will list many issues found already.

Best regards,
Erwin