[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Bug-gnulib] Re: xgetdomainname.c should include stdlib.h
From: |
Simon Josefsson |
Subject: |
[Bug-gnulib] Re: xgetdomainname.c should include stdlib.h |
Date: |
Mon, 19 Apr 2004 00:41:26 +0200 |
User-agent: |
Gnus/5.110002 (No Gnus v0.2) Emacs/21.3.50 (gnu/linux) |
Jim Meyering <address@hidden> writes:
>>> BTW, wouldn't it be better without the `Get ...' comments?
>>> The `Get errno.' one certainly doesn't add anything useful.
>>
>> Yes, perhaps. The cases where I find those comments useful are when
>> checking if the header file is still required -- searching for the
>> function/variable name mentioned in the comment answer that quickly.
>
> The problem is that such comments can easily get out of date,
> e.g., when the code changes to depend on yet another function
> from the affected header file.
> If there were some way to automatically guarantee
> consistency, it might be worthwhile. Hm... but if we had
> that, then we wouldn't need the comments in the first place.
Right.
> This is also relevant to your getdate.h suggestion.
> For that same reason (risk of divergence), I prefer to keep
> most function describing comments in only one place: just above
> the actual function definition. Some people prefer to put that
> documentation in the .h file. In any case, it should appear in
> just one place unless you can ensure that the multiple copies
> will always remain identical.
Ok. Perhaps it makes sense to write these matters down? I don't
particularly care either way, as long as it doesn't generate problems,
but I do like consistency. Assuming consistency across all gnulib
files is a desired goal, that is.