Skip to content

Commit 8c55876

Browse files
committed
docs: add default log filename to documentation
- In addition, update docs for `ArcedNodeBuilder::set_log_file_path`
1 parent fa071fd commit 8c55876

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

src/builder.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,7 @@ impl ArcedNodeBuilder {
610610
self.inner.write().unwrap().set_storage_dir_path(storage_dir_path);
611611
}
612612

613-
/// Sets the log dir path if logs need to live separate from the storage directory path.
613+
/// Sets the log file path if logs need to live separate from the storage directory path.
614614
pub fn set_log_file_path(&self, log_file_path: String) {
615615
self.inner.write().unwrap().set_log_file_path(log_file_path);
616616
}

src/config.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ pub struct Config {
105105
pub storage_dir_path: String,
106106
/// The path where logs are stored.
107107
///
108-
/// If set to `None`, logs can be found in [`Config::storage_dir_path`] directory.
108+
/// If set to `None`, logs can be found in `ldk_node.log` in the [`Config::storage_dir_path`]
109+
/// directory.
109110
pub log_file_path: Option<String>,
110111
/// The used Bitcoin network.
111112
pub network: Network,

0 commit comments

Comments
 (0)