new version with git help

2026-08-11 22:35:01 +02:00
parent fea7fb7a59
commit 7c6a338326
7 changed files with 175 additions and 19 deletions
@@ -5,6 +5,8 @@ A small command-line-like Git module for Racket, implemented directly on top of
 ```racket
 (require git)

+(git 'help)
+(git 'help 'grep)
 (git 'status)
 (git 'diff)
 (git 'diff '--cached)
@@ -24,12 +26,32 @@ A small command-line-like Git module for Racket, implemented directly on top of
 `git` is an ordinary procedure; command names are symbols. `dgit` performs the
 same operation, displays a compact human-readable result, and returns that result.

+`(git 'help)` opens the locally installed Scribble documentation. A command can
+be supplied to jump directly to its section, for example `(git 'help 'restore)`
+or `(git 'help 'grep)`.
+
 For `grep`, the natural `(git 'grep '-i "pattern")` spelling is supported even
 though Racket's reader represents `-i` as the complex number `0-1i`; in grep
 option position that value is interpreted as Git's `-i` flag.

 The same operations are available as normal procedures such as `git-status`, `git-add`, `git-commit`, `git-tag`, `git-current-branch`, `git-switch`, and `git-checkout`.

+
+## Help
+
+Open the locally installed Scribble documentation through Racket's
+documentation cross-reference index:
+
+```racket
+(git 'help)
+(git 'help 'grep)
+(git 'help 'restore)
+```
+
+`raco setup git` builds and indexes the package documentation. The help command
+uses the indexed path and anchor instead of assuming a particular documentation
+directory.
+
 ## HTTPS credentials

 Version 0.2 adds persistent HTTPS credentials.  They are stored in the
@@ -97,7 +119,7 @@ operations use them automatically:

 ## Supported Git operations

-Version 0.2 supports repository discovery, init, clone, status, diff, add, restore, reset, grep, config,
+Version 0.2 supports help, repository discovery, init, clone, status, diff, add, restore, reset, grep, config,
 commit, branch, branch-current, switch, checkout, merge, lightweight tags, log, remotes, fetch,
 fast-forward-only pull, push, tag push, network transfer progress, and HTTPS username/token credentials.