This is the mail archive of the fortran@gcc.gnu.org mailing list for the GNU Fortran 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: [fortran, docs] Add embryonic gfc-internals.texi manual.


Brooks Moses wrote:
I've been collecting various bits of notes to myself about how the GFortran internals work, and it recently occurred to me that it would be useful to have these in a place somewhat more useful to everyone else. Thus, I'm proposing the addition of the attached gfc-internals.texi file to gcc/fortran.

The idea is that this will be sort of a notebook that we can add notes to as we're working on various pieces of the code, and hopefully this will eventually achieve a reasonably full coverage of the whole compiler. At present, it's rather a bare skeleton, with only a few things in it (and one of those is some notes on symbol-versioning that I copied in from the Wiki).

One particular thing I'd like comments on: I'm proposing the following policy for this, as documented in this paragraph from the introduction:

------------------------------------------------------------------------
Because this is intended largely as a shared collection of notes for
GFortran developers, the approval process is informal compared to the
rest of GCC.  Anyone with write access to the repository is authorized
to add text to this manual, or to make minor changes or deletions,
without waiting for approval.  (Substantial deletions or rewrites should
go through the usual approval process for non-maintainers.)  All changes
that are committed under this rule should be tested with @command{make
info} and either @command{make dvi} or @command{make pdf}, and should
follow the formatting conventions of the rest of the manual.
------------------------------------------------------------------------

How about putting this into the wiki? I don't think it makes much sense to distribute this documentation to the user, nor does it make much sense to have different versions for different future versions / branches. Also the entry barrier with .texi is higher (well, IMO).


Cheers,
- Tobi


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