From 31603ac6dacd0b47ec9f02d99bfdd0a7b683119c Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Sun, 31 Mar 2024 00:54:59 +0900
Subject: [PATCH] Deprecate watch_log_file

This feature has been broken for some time without any actual update
to fix it. Also the pyinotify package used hasn't been updated for 9
years and looks badly unmaintained.

Related-Bug: #1740111
Related-Bug: #2059855
Change-Id: If776fee0072d95737e1c19ad673a3c881a89de06
---
 oslo_log/_options.py                                         | 4 ++++
 .../notes/deprecate-watch-log-file-ba9524ae872e7c01.yaml     | 5 +++++
 2 files changed, 9 insertions(+)
 create mode 100644 releasenotes/notes/deprecate-watch-log-file-ba9524ae872e7c01.yaml

diff --git a/oslo_log/_options.py b/oslo_log/_options.py
index 34af4abc..1bb82b11 100644
--- a/oslo_log/_options.py
+++ b/oslo_log/_options.py
@@ -74,6 +74,10 @@ logging_cli_opts = [
                     + _IGNORE_MESSAGE),
     cfg.BoolOpt('watch-log-file',
                 default=False,
+                deprecated_for_removal=True,
+                deprecated_reason=('This function is known to have bene '
+                                   'broken for long time, and depends on '
+                                   'the unmaintained library'),
                 help='Uses logging handler designed to watch file '
                      'system. When log file is moved or removed this handler '
                      'will open a new log file with specified path '
diff --git a/releasenotes/notes/deprecate-watch-log-file-ba9524ae872e7c01.yaml b/releasenotes/notes/deprecate-watch-log-file-ba9524ae872e7c01.yaml
new file mode 100644
index 00000000..b72f8c77
--- /dev/null
+++ b/releasenotes/notes/deprecate-watch-log-file-ba9524ae872e7c01.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``watch_log_file`` option has been deprecated and will be removed in
+    a future release.