tools: add note to users re: frr.conf overwrite

Most software doesn't overwrite its own config files; vtysh's 'wr mem'
may be confusing, so add a note to the config file explaining changes
made may be overwritten.

Signed-off-by: Quentin Young <qlyoung@nvidia.com>

diff --git a/tools/etc/frr/frr.conf b/tools/etc/frr/frr.conf
index 61f7a656203472734accf21f693be6dd0231f496..5ee6d15c915c1403c8b7664e47ff7a8fef2fcd94 100644 (file)
--- a/tools/etc/frr/frr.conf
+++ b/tools/etc/frr/frr.conf
@@ -1,3 +1,10 @@
-# default to using syslog. /etc/rsyslog.d/45-frr.conf places the log
-# in /var/log/frr/frr.log
+# default to using syslog. /etc/rsyslog.d/45-frr.conf places the log in
+# /var/log/frr/frr.log
+#
+# Note:
+# FRR's configuration shell, vtysh, dynamically edits the live, in-memory
+# configuration while FRR is running. When instructed, vtysh will persist the
+# live configuration to this file, overwriting its contents. If you want to
+# avoid this, you can edit this file manually before starting FRR, or instruct
+# vtysh to write configuration to a different file.
 log syslog informational