On 10/9/19 1:20 AM, Jan Hubicka wrote: >> On Tue, Oct 8, 2019 at 10:06 PM Sandra Loosemore >> wrote: >>> >>> On 10/8/19 2:52 AM, luoxhu wrote: >>>> Hi, >>>> >>>> This is the formal documentation patch for IPA passes. Thanks. >>>> >>>> >>>> None of the IPA passes are documented in passes.texi. This patch adds >>>> a section IPA passes just before GIMPLE passes and RTL passes in >>>> Chapter 9 "Passes and Files of the Compiler". Also, a short description >>>> for each IPA pass is provided. >>>> gccint.pdf can be produced without errors. >>>> >>>> ChangeLog: >>>> PR middle-end/26241 >>>> * doc/lto.texi (IPA): Reference to the IPA passes. >>>> * doc/passes.texi (Pass manager): Add node IPA passes and >>>> description for each IPA pass. >>> >>> Thanks for submitting this documentation patch! The content looks >>> helpful to me, but I see that it has quite a few grammar bugs (I >>> understand how hard English is even for native speakers....), plus some >>> issues like indexing, cross-referencing, use of jargon without defining >>> it, etc. I think it would be more efficient for me to take over >>> polishing the text some more than to mark it up for you to fix, but I'd >>> like to give others a few days to comment on technical content first. >> >> I think the contents are OK for a first try, so please go ahead polishing >> and commit. We can then improve the content as followup (I'm making >> a note for myself to not forget). > > I will add some extra info once patch is in :) > > Thanks for working on this! I've checked in the attached version of the patch. I filled in a few more details myself, mainly explaining the jargon etc. BTW, I've been thinking my stage 3 documentation project for this year will be doing some general cleanup on the internals manual. Up until now I've been focusing on the user documentation on the theory that we have many more users than implementors, but the internals manual needs some TLC too. I saw the poor quality of our internal documentation came up at Cauldron too. :-( -Sandra