mirror/youki
1
0
Fork 0
mirror of https://github.com/containers/youki synced 2024-09-27 22:49:57 +02:00
Code Issues

Fix failing doc tests

Browse Source
This commit is contained in:
Furisto 2021-10-21 15:33:18 +02:00
parent 9b7d2707e0
commit f44ff1681a
No known key found for this signature in database
GPG Key ID: 40C5F0E00523478B
9 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
crates/libcontainer/src/container/builder.rs
View File

@ -24,8 +24,8 @@ pub struct ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
///
/// ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())
/// .with_root_path("/run/containers/youki")
@ -41,8 +41,8 @@ impl<'a> ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
///
/// let builder = ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref());
/// ```
@ -63,8 +63,8 @@ impl<'a> ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// # use youki::container::builder::ContainerBuilder;
/// # use youki::syscall::syscall::create_syscall;
/// # use libcontainer::container::builder::ContainerBuilder;
/// # use libcontainer::syscall::syscall::create_syscall;
///
/// ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())
/// .as_tenant()
@ -80,8 +80,8 @@ impl<'a> ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// # use youki::container::builder::ContainerBuilder;
/// # use youki::syscall::syscall::create_syscall;
/// # use libcontainer::container::builder::ContainerBuilder;
/// # use libcontainer::syscall::syscall::create_syscall;
///
/// ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())
/// .as_init("/var/run/docker/bundle")
@ -97,8 +97,8 @@ impl<'a> ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// # use youki::container::builder::ContainerBuilder;
/// # use youki::syscall::syscall::create_syscall;
/// # use libcontainer::container::builder::ContainerBuilder;
/// # use libcontainer::syscall::syscall::create_syscall;
///
/// ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())
/// .with_root_path("/run/containers/youki");
@ -113,8 +113,8 @@ impl<'a> ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// # use youki::container::builder::ContainerBuilder;
/// # use youki::syscall::syscall::create_syscall;
/// # use libcontainer::container::builder::ContainerBuilder;
/// # use libcontainer::syscall::syscall::create_syscall;
///
/// ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())
/// .with_pid_file(Some("/var/run/docker.pid"));
@ -129,8 +129,8 @@ impl<'a> ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// # use youki::container::builder::ContainerBuilder;
/// # use youki::syscall::syscall::create_syscall;
/// # use libcontainer::container::builder::ContainerBuilder;
/// # use libcontainer::syscall::syscall::create_syscall;
///
/// ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())
/// .with_console_socket(Some("/var/run/docker/sock.tty"));
@ -145,8 +145,8 @@ impl<'a> ContainerBuilder<'a> {
/// # Example
///
/// ```no_run
/// # use youki::container::builder::ContainerBuilder;
/// # use youki::syscall::syscall::create_syscall;
/// # use libcontainer::container::builder::ContainerBuilder;
/// # use libcontainer::syscall::syscall::create_syscall;
///
/// ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())
/// .with_preserved_fds(5);

4
crates/libcontainer/src/container/container_delete.rs
View File

@ -12,8 +12,8 @@ impl Container {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
///
/// # fn main() -> anyhow::Result<()> {
/// let mut container = ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())

4
crates/libcontainer/src/container/container_events.rs
View File

@ -11,8 +11,8 @@ impl Container {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
///
/// # fn main() -> anyhow::Result<()> {
/// let mut container = ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())

4
crates/libcontainer/src/container/container_kill.rs
View File

@ -9,8 +9,8 @@ impl Container {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
/// use nix::sys::signal::Signal;
///
/// # fn main() -> anyhow::Result<()> {

4
crates/libcontainer/src/container/container_pause.rs
View File

@ -10,8 +10,8 @@ impl Container {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
///
/// # fn main() -> anyhow::Result<()> {
/// let mut container = ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())

4
crates/libcontainer/src/container/container_resume.rs
View File

@ -11,8 +11,8 @@ impl Container {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
///
/// # fn main() -> anyhow::Result<()> {
/// let mut container = ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())

4
crates/libcontainer/src/container/container_start.rs
View File

@ -13,8 +13,8 @@ impl Container {
/// # Example
///
/// ```no_run
/// use youki::container::builder::ContainerBuilder;
/// use youki::syscall::syscall::create_syscall;;
/// use libcontainer::container::builder::ContainerBuilder;
/// use libcontainer::syscall::syscall::create_syscall;;
///
/// # fn main() -> anyhow::Result<()> {
/// let mut container = ContainerBuilder::new("74f1a4cb3801".to_owned(), create_syscall().as_ref())

2
crates/libcontainer/src/container/state.rs
View File

@ -148,7 +148,7 @@ impl State {
///
/// ```
/// # use std::path::Path;
/// # use youki::container::State;
/// # use libcontainer::container::State;
///
/// let container_root = Path::new("/var/run/containers/container");
/// let state_file = State::file_path(&container_root);

2
crates/libcontainer/src/utils.rs
View File

@ -96,7 +96,7 @@ pub fn open<P: AsRef<Path>>(path: P) -> Result<File> {
/// is the owner that has been specified
/// # Example
/// ``` no_run
/// use youki::utils::create_dir_all_with_mode;
/// use libcontainer::utils::create_dir_all_with_mode;
/// use nix::sys::stat::Mode;
/// use std::path::Path;
///