Re: documentation structure (was: attribute: add comments)

2020-05-10 Thread Paul Eggert
On 5/10/20 1:24 PM, Bruno Haible wrote: > I view ATTRIBUTE_PURE, ATTRIBUTE_CONST as mainly an optimization hint. They > produce diagnostics only if the attribute has been misplaced, or you can let > the compiler suggest to you where these attribute would make sense. But what > would be the diagnos

Re: documentation structure (was: attribute: add comments)

2020-05-10 Thread Bruno Haible
Hi Paul, > ATTRIBUTE_NONNULL is not merely about compiler diagnostics; it's also > about optimization. Similarly for ATTRIBUTE_RETURNS_NONNULL (which I think was > primarily motivated by optimization). OK, let me tweak the comment (patch below). > Conversely, ATTRIBUTE_PURE, > ATTRIBUTE_CONST an

Re: documentation structure (was: attribute: add comments)

2020-05-10 Thread Paul Eggert
On 5/10/20 10:20 AM, Bruno Haible wrote: > Let me try to reinstante the answer to 1. "Why, when", by grouping the macros > according to their use-case. Sure, that's OK. Some quibbles, though. The distinction between compiler diagnostics and the other sections is somewhat confusing. ATTRIBUTE_NON

Re: documentation structure (was: attribute: add comments)

2020-05-10 Thread Bruno Haible
Hi Paul, > I went through > the comments and tweaked them in a way that I hope makes them even clearer. In doing so, unfortunately, in several places you removed the first sentence, which answered the question "What is its use-case?". Generally, it's a good guideline to structure the technical d

Re: documentation structure

2008-01-12 Thread Bruno Haible
I wrote and Eric Blake agreed: > | If gnulib implements a significant number of functions specified by glibc > | - strsignal was just mentioned - then I'm in favour two additional chapters > | * GNU libc Header File Substitutes > | * GNU libc Function Substitutes > | that makes it clear that th

Re: documentation structure

2008-01-07 Thread Eric Blake
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 According to Bruno Haible on 1/7/2008 5:58 PM: | I'm therefore in favour of putting this description under "Particular Modules". | | If gnulib implements a significant number of functions specified by glibc | - strsignal was just mentioned - then I'm

Re: documentation structure (was: Re: test-memmem takes waaay too long)

2008-01-07 Thread Bruno Haible
Eric Blake wrote: > I'm installing these two commits: > > * modules/memmem-tests (configure.ac): Check for alarm. > * tests/test-memmem.c (main): Avoid alarm on platforms that lack it. Thanks for these. > * doc/functions/memmem.texi: New file. > * doc/gnulib.texi (Function Substitutes): Add memm

gnulib documentation structure

2006-10-23 Thread Bruno Haible
Hi, I'm restructuring the gnulib documentation: 1) to separate the random notes from the documentation of individual modules, 2) to move the gnulib-tool invocation before all these detail descriptions, because how to use gnulib-tool is now important for every gnulib user. 2006-10-21 Bru