From 324d33010278947e45fd1e99439ce2ef8d48e404 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Sun, 16 Apr 2023 19:28:07 +0200 Subject: [PATCH] Document basic git functionality. --- doc/utils.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/utils.md b/doc/utils.md index cc7dbff..a69617d 100644 --- a/doc/utils.md +++ b/doc/utils.md @@ -162,6 +162,24 @@ Converts given number to a string with two-digit fractional part. Should the fractional part be 0, it is replaced with the string "--". +### Git + + (import util-git) + +This module provides basic git repository querying functionality. + + (git repo [mode]) + +* ```repo``` - a path to repository +* ```mode``` - return values mode for operations + +Returns a procedure that allows invocation of git in given ```repo``` +repository returning one or two values based on ```mode``` given: + +* ```#:exit``` - returns exit code +* ```#:output``` - returns the output lines (default) +* ```#:exit+output``` - returns both exit code and output lines + ### IO (import util-io)