mirror of
https://github.com/isc-projects/bind9.git
synced 2026-04-15 22:09:31 -04:00
Update dev documentation to explicitly mention that #include <config.h> should not be used
This commit is contained in:
parent
c2637c8429
commit
2621db706e
1 changed files with 5 additions and 2 deletions
|
|
@ -125,6 +125,10 @@ The following lint and lint-like comments should be used where appropriate:
|
|||
should prevent multiple inclusion. The OS is assumed to prevent multiple
|
||||
inclusion of its .h files.
|
||||
|
||||
The `#pragma once` directive should be used instead of `#ifdef/#define`
|
||||
combo, and the `#include <config.h>` should not be used anywhere, the
|
||||
build system ensures that it's the first included file.
|
||||
|
||||
A header file defining a public interface is generally placed in the source
|
||||
tree two levels below the C file that implements the interface. For
|
||||
example, the include file defining the interface for `lib/dns/zone.c` is in
|
||||
|
|
@ -155,8 +159,7 @@ or for public files that do not declare any functions.
|
|||
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
#ifndef ISC_WHATEVER_H
|
||||
#define ISC_WHATEVER_H 1
|
||||
#pragma once
|
||||
|
||||
/*****
|
||||
***** Module Info
|
||||
|
|
|
|||
Loading…
Reference in a new issue