From 029c7373801b9e1791df334efa36588c216b4ab2 Mon Sep 17 00:00:00 2001
From: Mark Salyzyn
Date: Tue, 16 Feb 2016 10:35:06 -0800
Subject: liblog: document fakeLogClose never to be called

(cherry pick from commit bc81b17e06cb23501eeca03a530b3a90858ac7c3)

Bug: 27107691
Change-Id: Ia699646ec2e83ca46f8b62b5d4f144e533b36074
---
 liblog/fake_log_device.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'liblog/fake_log_device.c')

diff --git a/liblog/fake_log_device.c b/liblog/fake_log_device.c
index 20e409861..aa88bedf8 100644
--- a/liblog/fake_log_device.c
+++ b/liblog/fake_log_device.c
@@ -691,6 +691,17 @@ int fakeLogOpen(const char *pathName, int flags)
     return redirectOpen(pathName, flags);
 }
 
+/*
+ * The logger API has no means or need to 'stop' or 'close' using the logs,
+ * and as such, there is no way for that 'stop' or 'close' to translate into
+ * a close operation to the fake log handler. fakeLogClose is provided for
+ * completeness only.
+ *
+ * We have no intention of adding a log close operation as it would complicate
+ * every user of the logging API with no gain since the only valid place to
+ * call is in the exit handler. Logging can continue in the exit handler to
+ * help debug HOST tools ...
+ */
 int fakeLogClose(int fd)
 {
     /* Assume that open() was called first. */
-- 
cgit v1.2.3-54-g00ecf