From: Elias Rohrer <ero@tnull.de>
Date: Wed, 24 Aug 2022 11:59:58 +0000 (+0200)
Subject: Export and document all `log` macros.
X-Git-Tag: v0.0.111~26^2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=c7c88a6572400ccdc60def75d24f0b169d6e3353;p=rust-lightning

Export and document all `log` macros.

Previously, only `log_error` and `log_trace` macros have been exported.
This change exports the macros of all log levels, which enables them to
be used downstream.
---

diff --git a/lightning/src/util/macro_logger.rs b/lightning/src/util/macro_logger.rs
index 63496b283..cd79a3f7b 100644
--- a/lightning/src/util/macro_logger.rs
+++ b/lightning/src/util/macro_logger.rs
@@ -160,6 +160,7 @@ macro_rules! log_internal {
 }
 
 /// Logs an entry at the given level.
+#[doc(hidden)]
 #[macro_export]
 macro_rules! log_given_level {
 	($logger: expr, $lvl:expr, $($arg:tt)+) => (
@@ -185,7 +186,7 @@ macro_rules! log_given_level {
 	);
 }
 
-/// Log an error.
+/// Log at the `ERROR` level.
 #[macro_export]
 macro_rules! log_error {
 	($logger: expr, $($arg:tt)*) => (
@@ -193,25 +194,31 @@ macro_rules! log_error {
 	)
 }
 
+/// Log at the `WARN` level.
+#[macro_export]
 macro_rules! log_warn {
 	($logger: expr, $($arg:tt)*) => (
 		log_given_level!($logger, $crate::util::logger::Level::Warn, $($arg)*);
 	)
 }
 
+/// Log at the `INFO` level.
+#[macro_export]
 macro_rules! log_info {
 	($logger: expr, $($arg:tt)*) => (
 		log_given_level!($logger, $crate::util::logger::Level::Info, $($arg)*);
 	)
 }
 
+/// Log at the `DEBUG` level.
+#[macro_export]
 macro_rules! log_debug {
 	($logger: expr, $($arg:tt)*) => (
 		log_given_level!($logger, $crate::util::logger::Level::Debug, $($arg)*);
 	)
 }
 
-/// Log a trace log.
+/// Log at the `TRACE` level.
 #[macro_export]
 macro_rules! log_trace {
 	($logger: expr, $($arg:tt)*) => (
@@ -219,7 +226,8 @@ macro_rules! log_trace {
 	)
 }
 
-/// Log a gossip log.
+/// Log at the `GOSSIP` level.
+#[macro_export]
 macro_rules! log_gossip {
 	($logger: expr, $($arg:tt)*) => (
 		log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);