diff --git a/man/clean.Rd b/man/clean.Rd index 9f0646e4..bf93399c 100644 --- a/man/clean.Rd +++ b/man/clean.Rd @@ -4,10 +4,13 @@ \alias{clean} \title{Clean Rust binaries and package cache.} \usage{ -clean(path = ".") +clean(path = ".", echo = TRUE) } \arguments{ \item{path}{[ string ] Path to the package root.} + +\item{echo}{logical scalar, should cargo command and outputs be printed to +console (default is TRUE)} } \description{ Removes Rust binaries (such as \code{.dll}/\code{.so} libraries), C wrapper object files, @@ -15,3 +18,8 @@ invokes \verb{cargo clean} to reset cargo target directory (found by default at \verb{pkg_root/src/rust/target/}). Useful when Rust code should be recompiled from scratch. } +\examples{ +\dontrun{ +clean() +} +} diff --git a/man/read_cargo_metadata.Rd b/man/read_cargo_metadata.Rd index 70d20284..61509c8b 100644 --- a/man/read_cargo_metadata.Rd +++ b/man/read_cargo_metadata.Rd @@ -4,10 +4,16 @@ \alias{read_cargo_metadata} \title{Retrieve metadata for packages and workspaces} \usage{ -read_cargo_metadata(path = ".") +read_cargo_metadata(path = ".", dependencies = FALSE, echo = TRUE) } \arguments{ \item{path}{character scalar, the R package directory} + +\item{dependencies}{logical scalar, whether to include all recursive +dependencies in stdout (default is FALSE)} + +\item{echo}{logical scalar, should cargo command and outputs be printed to +console (default is TRUE)} } \value{ \code{list}, including the following elements: diff --git a/man/use_crate.Rd b/man/use_crate.Rd index 1500d6bd..a9489281 100644 --- a/man/use_crate.Rd +++ b/man/use_crate.Rd @@ -10,7 +10,8 @@ use_crate( git = NULL, version = NULL, optional = FALSE, - path = "." + path = ".", + echo = TRUE ) } \arguments{ @@ -27,6 +28,9 @@ crate} (FALSE by default)} \item{path}{character scalar, the package directory} + +\item{echo}{logical scalar, should cargo command and outputs be printed to +console (default is TRUE)} } \value{ \code{NULL}, invisibly diff --git a/man/write_license_note.Rd b/man/write_license_note.Rd index cfdfb835..ff20923f 100644 --- a/man/write_license_note.Rd +++ b/man/write_license_note.Rd @@ -4,20 +4,29 @@ \alias{write_license_note} \title{Generate LICENSE.note file.} \usage{ -write_license_note(path = ".", quiet = FALSE, force = TRUE) +write_license_note(path = ".", echo = TRUE, quiet = FALSE, overwrite = TRUE) } \arguments{ -\item{path}{Path from which package root is looked up.} +\item{path}{character scalar, the R package directory} -\item{quiet}{Logical indicating whether any progress messages should be -generated or not.} +\item{echo}{logical scalar, whether to print cargo command and outputs to the +console (default is \code{TRUE})} -\item{force}{Logical indicating whether to regenerate LICENSE.note if LICENSE.note already exists.} +\item{quiet}{logical scalar, whether to signal successful writing of +LICENSE.note (default is \code{FALSE})} + +\item{overwrite}{logical scalar, whether to regenerate LICENSE.note if +LICENSE.note already exists (default is \code{TRUE})} } \value{ No return value, called for side effects. } \description{ -LICENSE.note generated by this function contains information about Rust crate dependencies. -To use this function, the \href{https://crates.io/crates/cargo-license}{cargo-license} command must be installed. +LICENSE.note generated by this function contains information about all +recursive dependencies in Rust crate. +} +\examples{ +\dontrun{ +write_license_note() +} }