Commit 2621db70 authored by Ondřej Surý's avatar Ondřej Surý
Browse files

Update dev documentation to explicitly mention that #include <config.h> should not be used

parent c2637c84
...@@ -125,6 +125,10 @@ The following lint and lint-like comments should be used where appropriate: ...@@ -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 should prevent multiple inclusion. The OS is assumed to prevent multiple
inclusion of its .h files. 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 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 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 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. ...@@ -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/. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/ */
#ifndef ISC_WHATEVER_H #pragma once
#define ISC_WHATEVER_H 1
/***** /*****
***** Module Info ***** Module Info
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment