On Tue, 31 Mar 2026, Sandra Loosemore wrote:

> On 3/30/26 12:11, Richard Biener wrote:
> > The following adds documentation for internal function details.  I
> > have populated the internal function tables via macro expansion
> > of the internal-fn.def file, so it's quite boiler-plate and asks
> > for manual amending in more complicated places.
> > 
> > Without such a place it's quite difficult to tell people to document
> > things when they add new internal functions.  We might want to split
> > the table into two, separating direct internal functions from others.
> > 
> > I have added some overall sentences related to internal functions
> > and builtins but left the API section as a FIXME.
> > 
> > I'm not sure we need a separate index - I have used IFN_ prefixes
> > which separates them nicely.  Removing those would warrant a
> > separate index.
> > 
> > I've placed the contents after the GENERIC/GIMPLE chapters.
> > 
> > I have looked over the generated pdf and it looks reasonable.
> > 
> > Is this OK to push in this state?  Or is "bad" documentation
> > worse than none?
> 
> I was not able to get the patch to build as-is, using texinfo 7.2. There were
> a missing menu entry, two @nodes with the same name, some bad markup on a
> @table, and a stray preprocessor line directive that gave a misleading
> location for the last of those errors.  I've attached a patch that goes on top
> of yours to fix those things, plus some punctuation and capitalization
> problems, typo/paste-o errors, etc.

Thanks for fixing that, I'm on texinfo 7.1 still.

> I'd also like to see the long lines >= 80 characters wrapped before this is
> pushed.  I didn't do that now because I thought it would obscure the other
> changes I made.

I have integrated your changes and wrapped long lines.  See v2 I sent out.

Richard.

> -Sandra
> 

-- 
Richard Biener <[email protected]>
SUSE Software Solutions Germany GmbH, Frankenstrasse 146, 90461 Nuernberg,
Germany; GF: Ivo Totev, Andrew Myers, Andrew McDonald, Boudien Moerman;
HRB 36809 (AG Nuernberg)

Reply via email to