docs: rustdoc warnings
Fixed a few rustdoc warnings. Converted some 'html'-links to intra-doc-links and surrounded paths with '`'. Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
This commit is contained in:
parent
76f32a29f8
commit
5116d051a8
@ -21,7 +21,7 @@
|
|||||||
//! chunks (VMs, whole block devices).
|
//! chunks (VMs, whole block devices).
|
||||||
//!
|
//!
|
||||||
//! A chunk is defined as a binary blob, which is stored inside a
|
//! A chunk is defined as a binary blob, which is stored inside a
|
||||||
//! [ChunkStore](struct.ChunkStore.html) instead of the backup directory
|
//! [ChunkStore] instead of the backup directory
|
||||||
//! directly, and can be addressed by its SHA256 digest.
|
//! directly, and can be addressed by its SHA256 digest.
|
||||||
//!
|
//!
|
||||||
//!
|
//!
|
||||||
@ -98,7 +98,7 @@
|
|||||||
//! still referenced.
|
//! still referenced.
|
||||||
//!
|
//!
|
||||||
//! To do this we use the
|
//! To do this we use the
|
||||||
//! [ProcessLocker](../tools/struct.ProcessLocker.html).
|
//! [ProcessLocker](proxmox_sys::process_locker::ProcessLocker).
|
||||||
//!
|
//!
|
||||||
//! ### ChunkStore-wide
|
//! ### ChunkStore-wide
|
||||||
//!
|
//!
|
||||||
|
@ -893,7 +893,7 @@ fn scsi_cmd_mode_sense(
|
|||||||
|
|
||||||
/// True if the given sense info is INVALID COMMAND OPERATION CODE
|
/// True if the given sense info is INVALID COMMAND OPERATION CODE
|
||||||
/// means that the device does not know/support the command
|
/// means that the device does not know/support the command
|
||||||
/// https://www.t10.org/lists/asc-num.htm#ASC_20
|
/// <https://www.t10.org/lists/asc-num.htm#ASC_20>
|
||||||
pub fn sense_err_is_invalid_command(err: &SenseInfo) -> bool {
|
pub fn sense_err_is_invalid_command(err: &SenseInfo) -> bool {
|
||||||
err.sense_key == SENSE_KEY_ILLEGAL_REQUEST && err.asc == 0x20 && err.ascq == 0x00
|
err.sense_key == SENSE_KEY_ILLEGAL_REQUEST && err.asc == 0x20 && err.ascq == 0x00
|
||||||
}
|
}
|
||||||
|
@ -135,7 +135,7 @@ pub fn list_datastore_mounts() -> Result<Vec<DatastoreMountInfo>, Error> {
|
|||||||
permission: &Permission::Privilege(&["system", "disks"], PRIV_SYS_MODIFY, false),
|
permission: &Permission::Privilege(&["system", "disks"], PRIV_SYS_MODIFY, false),
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Create a Filesystem on an unused disk. Will be mounted under '/mnt/datastore/<name>'.".
|
/// Create a Filesystem on an unused disk. Will be mounted under `/mnt/datastore/<name>`.
|
||||||
pub fn create_datastore_disk(
|
pub fn create_datastore_disk(
|
||||||
name: String,
|
name: String,
|
||||||
disk: String,
|
disk: String,
|
||||||
@ -235,7 +235,7 @@ pub fn create_datastore_disk(
|
|||||||
permission: &Permission::Privilege(&["system", "disks"], PRIV_SYS_MODIFY, false),
|
permission: &Permission::Privilege(&["system", "disks"], PRIV_SYS_MODIFY, false),
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Remove a Filesystem mounted under '/mnt/datastore/<name>'.
|
/// Remove a Filesystem mounted under `/mnt/datastore/<name>`.
|
||||||
pub fn delete_datastore_disk(name: String) -> Result<(), Error> {
|
pub fn delete_datastore_disk(name: String) -> Result<(), Error> {
|
||||||
let path = format!("{}{}", BASE_MOUNT_DIR, name);
|
let path = format!("{}{}", BASE_MOUNT_DIR, name);
|
||||||
// path of datastore cannot be changed
|
// path of datastore cannot be changed
|
||||||
|
@ -147,7 +147,7 @@ pub fn zpool_details(name: String) -> Result<Value, Error> {
|
|||||||
permission: &Permission::Privilege(&["system", "disks"], PRIV_SYS_MODIFY, false),
|
permission: &Permission::Privilege(&["system", "disks"], PRIV_SYS_MODIFY, false),
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Create a new ZFS pool. Will be mounted under '/mnt/datastore/<name>'.
|
/// Create a new ZFS pool. Will be mounted under `/mnt/datastore/<name>`.
|
||||||
pub fn create_zpool(
|
pub fn create_zpool(
|
||||||
name: String,
|
name: String,
|
||||||
devices: String,
|
devices: String,
|
||||||
|
@ -301,7 +301,7 @@ async fn call_api_and_format_result(
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Call API on <api-path>
|
/// Call API on `<api-path>`
|
||||||
async fn api_call(
|
async fn api_call(
|
||||||
method: String,
|
method: String,
|
||||||
api_path: String,
|
api_path: String,
|
||||||
@ -327,7 +327,7 @@ async fn api_call(
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Get API usage information for <path>
|
/// Get API usage information for `<path>`
|
||||||
async fn usage(
|
async fn usage(
|
||||||
path: String,
|
path: String,
|
||||||
verbose: bool,
|
verbose: bool,
|
||||||
@ -427,7 +427,7 @@ async fn get_api_children(
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Get API usage information for <path>
|
/// Get API usage information for `<path>`
|
||||||
async fn ls(
|
async fn ls(
|
||||||
path: Option<String>,
|
path: Option<String>,
|
||||||
mut param: Value,
|
mut param: Value,
|
||||||
|
@ -299,7 +299,7 @@ fn list_datastore_mounts(
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Create a Filesystem on an unused disk. Will be mounted under '/mnt/datastore/<name>'.
|
/// Create a Filesystem on an unused disk. Will be mounted under `/mnt/datastore/<name>`.
|
||||||
async fn create_datastore_disk(
|
async fn create_datastore_disk(
|
||||||
mut param: Value,
|
mut param: Value,
|
||||||
rpcenv: &mut dyn RpcEnvironment,
|
rpcenv: &mut dyn RpcEnvironment,
|
||||||
@ -326,7 +326,7 @@ async fn create_datastore_disk(
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
)]
|
)]
|
||||||
/// Remove a Filesystem mounted under '/mnt/datastore/<name>'.
|
/// Remove a Filesystem mounted under `/mnt/datastore/<name>`.
|
||||||
async fn delete_datastore_disk(
|
async fn delete_datastore_disk(
|
||||||
mut param: Value,
|
mut param: Value,
|
||||||
rpcenv: &mut dyn RpcEnvironment,
|
rpcenv: &mut dyn RpcEnvironment,
|
||||||
|
@ -547,7 +547,7 @@ pub enum DiskType {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
/// Represents the contents of the /sys/block/<dev>/stat file.
|
/// Represents the contents of the `/sys/block/<dev>/stat` file.
|
||||||
pub struct BlockDevStat {
|
pub struct BlockDevStat {
|
||||||
pub read_ios: u64,
|
pub read_ios: u64,
|
||||||
pub read_sectors: u64,
|
pub read_sectors: u64,
|
||||||
@ -668,7 +668,7 @@ pub struct PartitionInfo {
|
|||||||
#[serde(rename_all = "kebab-case")]
|
#[serde(rename_all = "kebab-case")]
|
||||||
/// Information about how a Disk is used
|
/// Information about how a Disk is used
|
||||||
pub struct DiskUsageInfo {
|
pub struct DiskUsageInfo {
|
||||||
/// Disk name (/sys/block/<name>)
|
/// Disk name (`/sys/block/<name>`)
|
||||||
pub name: String,
|
pub name: String,
|
||||||
pub used: DiskUsageType,
|
pub used: DiskUsageType,
|
||||||
pub disk_type: DiskType,
|
pub disk_type: DiskType,
|
||||||
|
Loading…
Reference in New Issue
Block a user