[tor-commits] [tor/master] Add a dire warning about not reformatting the whole codebase yet.

[nickm at torproject.org]

commit b5ccdd978ea138cde92b3513c9d653ba18b8b463
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Feb 12 18:52:35 2020 -0500

    Add a dire warning about not reformatting the whole codebase yet.
---
 .clang-format                 | 5 +++++
 scripts/maint/clang-format.sh | 7 +++++++
 scripts/maint/codetool.py     | 8 ++++++++
 3 files changed, 20 insertions(+)

diff --git a/.clang-format b/.clang-format
index e688ce7df..7be73e061 100644
--- a/.clang-format
+++ b/.clang-format
@@ -1,3 +1,8 @@
+# DO NOT COMMIT OR MERGE CODE THAT IS RUN THROUGH THIS TOOL YET.
+#
+# WE ARE STILL DISCUSSING OUR DESIRED STYLE AND ITERATING ON IT.
+#     (12 Feb 2020)
+
 ---
 Language:        Cpp
 # Out of all supported styles, LLVM seems closest to our own.
diff --git a/scripts/maint/clang-format.sh b/scripts/maint/clang-format.sh
index 86430b9b2..59832117b 100755
--- a/scripts/maint/clang-format.sh
+++ b/scripts/maint/clang-format.sh
@@ -2,6 +2,13 @@
 # Copyright 2020, The Tor Project, Inc.
 # See LICENSE for licensing information.
 
+#
+# DO NOT COMMIT OR MERGE CODE THAT IS RUN THROUGH THIS TOOL YET.
+#
+# WE ARE STILL DISCUSSING OUR DESIRED STYLE AND ITERATING ON IT.
+#     (12 Feb 2020)
+#
+
 # This script runs "clang-format" and "codetool" in sequence over each of
 # our source files, and replaces the original file only if it has changed.
 #
diff --git a/scripts/maint/codetool.py b/scripts/maint/codetool.py
index 6336e6843..725712c0c 100755
--- a/scripts/maint/codetool.py
+++ b/scripts/maint/codetool.py
@@ -2,6 +2,14 @@
 # Copyright (c) 2020, The Tor Project, Inc.
 # See LICENSE for licensing information.
 
+#
+# DO NOT COMMIT OR MERGE CODE THAT IS RUN THROUGH THIS TOOL YET.
+#
+# WE ARE STILL DISCUSSING OUR DESIRED STYLE AND ITERATING ON IT,
+# ALONG WITH THE TOOLS THAT ACHIEVE IT.
+#     (12 Feb 2020)
+#
+
 """
    This program uses a set of plugable filters to inspect and transform
    our C code.