X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=background-processor%2Fsrc%2Flib.rs;h=c3db4d55ade989e13fb8ac228ac77d6460d0502f;hb=836985a5e5e8036d5dea47797ef6fba498616e67;hp=1976962bea6ef8c7951be6bd818e638be36ff5e1;hpb=578f8b72e2e5a04726fd1d5b63f9642bfc74a4b7;p=rust-lightning

diff --git a/background-processor/src/lib.rs b/background-processor/src/lib.rs
index 1976962b..c3db4d55 100644
--- a/background-processor/src/lib.rs
+++ b/background-processor/src/lib.rs
@@ -1,3 +1,11 @@
+//! Utilities that take care of tasks that (1) need to happen periodically to keep Rust-Lightning
+//! running properly, and (2) either can or should be run in the background. See docs for
+//! [`BackgroundProcessor`] for more details on the nitty-gritty.
+
+#![deny(broken_intra_doc_links)]
+#![deny(missing_docs)]
+#![deny(unsafe_code)]
+
 #[macro_use] extern crate lightning;
 
 use lightning::chain;
@@ -40,18 +48,21 @@ impl BackgroundProcessor {
 	/// Start a background thread that takes care of responsibilities enumerated in the top-level
 	/// documentation.
 	///
-	/// If `persist_manager` returns an error, then this thread will return said error (and `start()`
-	/// will need to be called again to restart the `BackgroundProcessor`). Users should wait on
-	/// [`thread_handle`]'s `join()` method to be able to tell if and when an error is returned, or
-	/// implement `persist_manager` such that an error is never returned to the `BackgroundProcessor`
+	/// If `persist_manager` returns an error, then this thread will return said error (and
+	/// `start()` will need to be called again to restart the `BackgroundProcessor`). Users should
+	/// wait on [`thread_handle`]'s `join()` method to be able to tell if and when an error is
+	/// returned, or implement `persist_manager` such that an error is never returned to the
+	/// `BackgroundProcessor`
 	///
-	/// `persist_manager` is responsible for writing out the `ChannelManager` to disk, and/or uploading
-	/// to one or more backup services. See [`ChannelManager::write`] for writing out a `ChannelManager`.
-	/// See [`FilesystemPersister::persist_manager`] for Rust-Lightning's provided implementation.
+	/// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
+	/// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
+	/// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
+	/// provided implementation.
 	///
-	/// [`thread_handle`]: struct.BackgroundProcessor.html#structfield.thread_handle
-	/// [`ChannelManager::write`]: ../lightning/ln/channelmanager/struct.ChannelManager.html#method.write
-	/// [`FilesystemPersister::persist_manager`]: ../lightning_persister/struct.FilesystemPersister.html#impl
+	/// [`thread_handle`]: BackgroundProcessor::thread_handle
+	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
+	/// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
+	/// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
 	pub fn start<PM, Signer, M, T, K, F, L>(persist_manager: PM, manager: Arc<ChannelManager<Signer, Arc<M>, Arc<T>, Arc<K>, Arc<F>, Arc<L>>>, logger: Arc<L>) -> Self
 	where Signer: 'static + Sign,
 	      M: 'static + chain::Watch<Signer>,
@@ -268,7 +279,7 @@ mod tests {
 		loop {
 			let log_entries = nodes[0].logger.lines.lock().unwrap();
 			let desired_log = "Calling manager's timer_chan_freshness_every_min".to_string();
-			if log_entries.get(&("background_processor".to_string(), desired_log)).is_some() {
+			if log_entries.get(&("lightning_background_processor".to_string(), desired_log)).is_some() {
 				break
 			}
 		}