This is the mail archive of the gcc@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [tuples] API documentation


Diego Novillo <dnovillo@google.com> writes:

> I just finished going through the API document adding missing content
> and updating stale information.  While there are various aspects of
> GIMPLE that are not covered in the document, it is probably complete
> enough for converting/adding gimple code.
>
> At the moment I'm wondering what would be the best way to host this
> documentation.  Do we leave it on some web-based form (wiki or google
> docs)?  Do we move it to the source tree as .texi files?
>
> I can see advantages to both approaches.  Leaving it on the web, makes
> it easier to edit and evolve.  Moving to the source tree makes it
> easier to version but harder to edit.

I think that when it is reasonably stable it should move into a .texi
file in the source code.  That is there the gcc internals manual
lives.

I would not be averse to moving the entire internals manual to the web
in some form.  But having it in two places does not seem like a good
idea to me.

Ian


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]