- Commit
- 7819a086e0404233fff17a0a0d923da7b89bd7f1
- Parent
- 63a11a42223272cc5a7df11a6106377bdfb35145
- Author
- Pablo <pablo-pie@riseup.net>
- Date
Updated the docs
Yet another static site generator for Git 🙀️
Updated the docs
4 files changed, 18 insertions, 4 deletions
Status | Name | Changes | Insertions | Deletions |
Modified | README.md | 2 files changed | 6 | 0 |
Modified | src/command.rs | 2 files changed | 1 | 1 |
Modified | src/log.rs | 2 files changed | 1 | 1 |
Modified | yagit.1 | 2 files changed | 10 | 2 |
diff --git a/README.md b/README.md @@ -46,6 +46,12 @@ To initiliaze an empty repository at repository store run $ yagit init REPO_NAME ``` +Repositories managed by yagit can be deleted using the `delete` command: + +```console +$ yagit delete REPO_NAME +``` + For more information check the `yagit.1` man page. ## Limitations
diff --git a/src/command.rs b/src/command.rs @@ -166,7 +166,7 @@ fn usage(program_name: &str, tag: Option) { usageln!("{program_name} [{FULL_BUILD_FLAG}] [{PRIVATE_FLAG}] {RENDER_CMD} <repo-name>"); } Some(CmdTag::Init) => { - usageln!("{program_name} [{PRIVATE_FLAG}] {INIT_CMD} <repo-name>"); + usageln!("{program_name} [{PRIVATE_FLAG}] {INIT_CMD} <repo-name> <description>"); } Some(CmdTag::Delete) => { usageln!("{program_name} [{PRIVATE_FLAG}] {DELETE_CMD} <repo-name>");
diff --git a/src/log.rs b/src/log.rs @@ -56,7 +56,7 @@ pub(crate) fn log(level: Level, args: &Arguments<'_>) { Level::Usage => { print!("{BOLD_YELLOW} Usage{RESET} "); println!("{}", args); - println!(" For more information check the {UNDERLINE}yagit(1){RESET} man page."); + println!(" For more information check the {UNDERLINE}yagit(1){RESET} man page."); log_current_job(); } }
diff --git a/yagit.1 b/yagit.1 @@ -18,6 +18,10 @@ render .Op Fl \-\-private \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ init\ \ .Ar repo-name +.Nm +.Op Fl \-\-private +\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ delete +.Ar repo-name .Sh DESCRIPTION .Nm maintains a store of Git repositories at @@ -52,9 +56,13 @@ and updates the index page Renders the HTML pages for a repository at .Ar REPOS_DIR/repo\-name and updates the index page -.It \fBinit\fR Ar repo\-name -Initializes a bare Git repo at +.It \fBinit\fR Ar repo\-name Ar description +Initializes and configures a Git repo at +.Ar REPOS_DIR/repo\-name +.It \fBdelete\fR Ar repo\-name +Deletes the Git repository at .Ar REPOS_DIR/repo\-name +and re-renders the global repository index .El .Sh FLAGS .Bl -tag -width Ds