From e3a253d80f124f12b5ec3707216590eb5c0dccff Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Sat, 26 Oct 2019 17:20:44 +0300 Subject: [PATCH] document tasks module --- xtask/src/main.rs | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/xtask/src/main.rs b/xtask/src/main.rs index 06aa3c8eca..34eb63eb34 100644 --- a/xtask/src/main.rs +++ b/xtask/src/main.rs @@ -1,5 +1,12 @@ -//! FIXME: write short doc here - +//! See https://github.com/matklad/cargo-xtask/. +//! +//! This binary defines various auxiliary build commands, which are not +//! expressible with just `cargo`. Notably, it provides `cargo xtask codegen` +//! for code genetaiont and `cargo xtask install` for installation of +//! rust-analyzer server and client. +//! +//! This binary is integrated into the `cargo` command line by using an alias in +//! `.cargo/config`. mod help; use core::fmt::Write;