other/1078: Problems with attributes documentation

Joseph Myers jsm28@cam.ac.uk
Sat Dec 16 15:36:00 GMT 2000


>Number:         1078
>Category:       other
>Synopsis:       Problems with attributes documentation
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    unassigned
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sat Dec 16 15:36:00 PST 2000
>Closed-Date:
>Last-Modified:
>Originator:     Joseph S. Myers
>Release:        2.97 20001216 (experimental)
>Organization:
none
>Environment:
System: Linux decomino 2.2.18 #1 Thu Dec 14 19:30:45 UTC 2000 i686 unknown
Architecture: i686

	
host: i686-pc-linux-gnu
build: i686-pc-linux-gnu
target: i686-pc-linux-gnu
configured with: ../gcc-cvs/configure --prefix=/opt/gcc/snapshot --disable-shared --enable-threads=posix --with-system-zlib
>Description:

There are many problems with the documentation of attributes in
extend.texi:

1) The syntax of attributes on labels is undocumented, though it's
   mentioned in invoke.texi that attributes can be placed on labels.

2) The data attributes eightbit_data and tiny_data are listed under
   function attributes.

3) There is no documentation for the attributes "common" and
   "no_stack_limit".

4) There is no documentation for the C++ attributes "com_interface"
   and "init_priority" in extend.texi, though init_priority is
   mentioned in invoke.texi.

5) Several attributes have documented lists of targets for which they
   are implemented, but those lists are incomplete, not mentioning
   some implemented targets:

        Attribute       Machines not documented
        =========       =======================
        interrupt       ARC, C4X, V850, m68hc11
        dllimport       ARM/pe, MCore, i386 Windows NT
        dllexport       ARM/pe, MCore, i386 Windows NT
        stdcall         ns32k
        cdecl           ns32k
        naked           MCore
        interrupt_handler   SH, V850

6) Several machine-specific attributes are not documented:

        Attribute       Machine
        =========       =======
        overlaid        VMS on Alpha
        isr             ARM
        progmem         AVR
        assembler       C4X
        leaf_pretend    C4X
        OS_Task         H8/300
        monitor         H8/300
        syscall_linkage IA64
        sp_switch       SH
        trap_exit       SH
        sda             V850
        tda             V850
        zda             V850
        trap            m68hc11

>How-To-Repeat:

Find undocumented attributes in the source code or alluded to in other
bits of documentation.

>Fix:

Document all attributes, using machine-specific knowledge where
necessary.
>Release-Note:
>Audit-Trail:
>Unformatted:


More information about the Gcc-prs mailing list