annotate lib/ignore-value.h @ 10780:5c7a68d31801

Add support for Haiku.
author Bruno Haible <bruno@clisp.org>
date Mon, 10 Nov 2008 12:37:32 +0100
parents c205b195801d
children 7848aae2799c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10650
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
1 /* ignore a value to quiet a compiler warning
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
2
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
3 Copyright (C) 2008 Free Software Foundation, Inc.
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
4
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
5 This program is free software: you can redistribute it and/or modify
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
8 (at your option) any later version.
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
9
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
13 GNU General Public License for more details.
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
14
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
17
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
18 /* Written by Jim Meyering. */
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
19
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
20 #ifndef __attribute__
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
21 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
22 # define __attribute__(x)
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
23 # endif
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
24 #endif
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
25
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
26 /* Use this function to avoid a warning when using a function declared with
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
27 gcc's warn_unused_result attribute, but for which you really do want to
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
28 ignore the result. Traditionally, people have used a "(void)" cast to
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
29 indicate that a function's return value is deliberately unused. However,
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
30 if the function is declared with __attribute__((warn_unused_result)),
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
31 gcc issues a warning even with the cast.
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
32
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
33 Caution: most of the time, you really should heed gcc's warning, and
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
34 check the return value. However, in those exceptional cases in which
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
35 you're sure you know what you're doing, use this function.
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
36
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
37 For the record, here's one of the ignorable warnings:
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
38 "copy.c:233: warning: ignoring return value of 'fchown',
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
39 declared with attribute warn_unused_result". */
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
40
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
41 static inline void
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
42 ignore_value (int i __attribute__ ((__unused__)))
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
43 {
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
44 /* empty */
c205b195801d ignore-value: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
45 }