aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Erat <derat@chromium.org>2017-08-24 14:29:49 -0700
committerDan Erat <derat@chromium.org>2017-08-25 13:46:30 +0000
commit35dcdc75d8e20ebe9ab68b8b8eafe6fb11817d69 (patch)
tree55019e8ebb26aff2fc19d3666fc3004dbee4561e
parentc5bf48bbc85f034f9e4dfa67348840082d5f7d41 (diff)
downloadplatform_external_libbrillo-35dcdc75d8e20ebe9ab68b8b8eafe6fb11817d69.tar.gz
platform_external_libbrillo-35dcdc75d8e20ebe9ab68b8b8eafe6fb11817d69.tar.bz2
platform_external_libbrillo-35dcdc75d8e20ebe9ab68b8b8eafe6fb11817d69.zip
libbrillo: Steer people away from GLib.
Add a brillo/glib/README.md file and some comments warning people away from dbus-glib and GLib. BUG=none TEST=none Change-Id: Iee63ae626fbd630be4d224be47a3d6401ba63902
-rw-r--r--brillo/glib/README.md5
-rw-r--r--brillo/glib/abstract_dbus_service.h3
-rw-r--r--brillo/glib/dbus.h3
3 files changed, 11 insertions, 0 deletions
diff --git a/brillo/glib/README.md b/brillo/glib/README.md
new file mode 100644
index 0000000..ef9ec9e
--- /dev/null
+++ b/brillo/glib/README.md
@@ -0,0 +1,5 @@
+# libbrillo GLib support
+
+GLib is deprecated in Chrome OS. Use [libchrome] instead.
+
+[libchrome]: ../../../libchrome
diff --git a/brillo/glib/abstract_dbus_service.h b/brillo/glib/abstract_dbus_service.h
index bac145b..32725c7 100644
--- a/brillo/glib/abstract_dbus_service.h
+++ b/brillo/glib/abstract_dbus_service.h
@@ -5,6 +5,9 @@
#ifndef LIBBRILLO_BRILLO_GLIB_ABSTRACT_DBUS_SERVICE_H_
#define LIBBRILLO_BRILLO_GLIB_ABSTRACT_DBUS_SERVICE_H_
+// IMPORTANT: Do not use this in new code. Instead, use
+// <brillo/daemons/dbus_daemon.h>. See https://goo.gl/EH3MmR for more details.
+
#include <brillo/brillo_export.h>
#include <brillo/glib/dbus.h>
diff --git a/brillo/glib/dbus.h b/brillo/glib/dbus.h
index a44b653..7a28480 100644
--- a/brillo/glib/dbus.h
+++ b/brillo/glib/dbus.h
@@ -5,6 +5,9 @@
#ifndef LIBBRILLO_BRILLO_GLIB_DBUS_H_
#define LIBBRILLO_BRILLO_GLIB_DBUS_H_
+// IMPORTANT: Do not use this in new code. Instead, use libchrome's D-Bus
+// bindings. See https://goo.gl/EH3MmR for more details.
+
#include <dbus/dbus-glib.h>
#include <glib-object.h>