vpr: Add deprecation warning to breadth-first router
The breadth-first router does not optimize for timing and has
significantly worse run-time than the timing-driven router (even without
timing information).
diff --git a/vpr/src/route/route_breadth_first.cpp b/vpr/src/route/route_breadth_first.cpp
index 2fa9b74..3ff2eca 100644
--- a/vpr/src/route/route_breadth_first.cpp
+++ b/vpr/src/route/route_breadth_first.cpp
@@ -34,6 +34,21 @@
* (FPGA 95 p. 111). Returns true if it can route this FPGA, false if *
* it can't. */
+ VTR_LOG(
+ "**********************************************************************\n"
+ "* !!! WARNING !!! *\n"
+ "* *\n"
+ "* Routing with the DEPRECATED 'Breadth-First' router, which *\n"
+ "* is inferrior and may be removed in a future release. *\n"
+ "* *\n"
+ "* Use the 'Timing-Driven' router instead, which requires much *\n"
+ "* less run-time and produces higher quality results *\n"
+ "* (even with it no timing information is available). *\n"
+ "* *\n"
+ "* !!! WARNING !!! *\n"
+ "**********************************************************************\n"
+ "\n");
+
float pres_fac;
bool success, is_routable, rip_up_local_opins;
int itry;
