shared/trivial: add code comment about the purpose of "nm-default.h" header

This commit is contained in:
Thomas Haller 2020-09-01 17:27:17 +02:00
parent cc763243e0
commit d619de7727
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728

View file

@ -3,6 +3,16 @@
* Copyright (C) 2015 Red Hat, Inc.
*/
/* With autotools (and also meson), all our source files are expected to include <config.h>.
* as very first header. Then they are expected to include "config-extra.h" and a small set
* of headers that we always want to have included (depending on what sources we compile
* (as determined by NETWORKMANAGER_COMPILATION define) that can be "nm-glib-aux/nm-macros-internal.h"
* and similar.
*
* To simplify that, all our source files are only expected to include "nm-default.h" as first,
* and thereby rely on getting a basic set of headers already.
*/
#ifndef __NM_DEFAULT_H__
#define __NM_DEFAULT_H__