[LLVMdev] (Function) attributes documentation

[Devang Patel]

Hi Matthijs,

On Oct 6, 2008, at 9:23 AM, Matthijs Kooijman wrote:

> Hi all,
>
> due to the recent changes regarding paramater/function/return type  
> attributes,
> I think the documentation around that could use some improvement. In
> particular, I see the following problems:
> * The section "Functions" in the LangRef has a large textual  
> description
>   about how it should look, but no definition of syntax, or even a few
> 	 examples of the syntax. This makes it very hard to read.

This description provides links for each item. Do you think we need an  
example here?

>
> * The section "Functions" only mentions return value attributes and  
> parameter
>   attributes, but not function attributes.

Fixed
>
> * The section about the call and invoke instructions do not mention  
> any
>   attributes at all.

Fixed
>
> * The section about parameter attributes is a bit unclear as to what  
> are
>   valid return attributes and what are valid parameter attributes.  
> From the
> 	 code, only zeroext, signext and inreg are valid for return values,  
> but
> 	 adding an explicit "This is not a valid attribute for return  
> values" to the
> 	 others would make this a lot clearer.

Fixed
>
>
> These problems seem to have been around for some time, but I guess  
> it would be
> good to fix them (but I won't be having the time for it,  
> unfortunately).


Let me know, if the docs are clear now or if we can improve them.
Thanks,
-
Devang