Re: Re: [RFC] Documenting support functions and data structures

2015-04-25 Thread Joseph Myers
On Thu, 16 Apr 2015, Manuel López-Ibáñez wrote: > And yes, I would also be extremely happy if someone figured out a way to > ensure the docs match the comments. We can probably automatically generate > from the *.opt files most of invoke.texi and even the list of what enables > what. But there are

Re: [RFC] Documenting support functions and data structures

2015-04-16 Thread Manuel López-Ibáñez
On 16 April 2015 at 17:15, Andrew Haley wrote: > However, I am advising caution, particularly when documenting > structures whose shape might soon change. And with respect to new > contributions, it would be a shame if someone came along, did a great > job of documenting the structures and interf

Re: [RFC] Documenting support functions and data structures

2015-04-16 Thread Andrew Haley
On 04/16/2015 02:22 PM, Manuel López-Ibáñez wrote: > On 16/04/15 10:04, Andrew Haley wrote: >> On 16/04/15 06:12, Mikhail Maltsev wrote: >>> So, I want to create a similar page in GCC's internal docs, but I don't >>> know what should be included (i.e. did I miss something important, or >>> did I in

Re: [RFC] Documenting support functions and data structures

2015-04-16 Thread Trevor Saunders
On Thu, Apr 16, 2015 at 08:12:17AM +0300, Mikhail Maltsev wrote: > Hi, all! > > I think GCC documentation is missing a description of commonly used data > structures and support functions. For example, "GCC internals" document > contains information about, say, GIMPLE IR and functions for > manipu

Re: Re: [RFC] Documenting support functions and data structures

2015-04-16 Thread Manuel López-Ibáñez
On 16/04/15 10:04, Andrew Haley wrote: On 16/04/15 06:12, Mikhail Maltsev wrote: So, I want to create a similar page in GCC's internal docs, but I don't know what should be included (i.e. did I miss something important, or did I include something obsolete), so I ask for some assistance. The re

Re: [RFC] Documenting support functions and data structures

2015-04-16 Thread Andrew Haley
On 16/04/15 06:12, Mikhail Maltsev wrote: > So, I want to create a similar page in GCC's internal docs, but I don't > know what should be included (i.e. did I miss something important, or > did I include something obsolete), so I ask for some assistance. The real challenge here is not generating t

[RFC] Documenting support functions and data structures

2015-04-15 Thread Mikhail Maltsev
Hi, all! I think GCC documentation is missing a description of commonly used data structures and support functions. For example, "GCC internals" document contains information about, say, GIMPLE IR and functions for manipulating it. But it does not describe general data structures, such as hash map