Skip to content

Commit ef60e42

Browse files
mbarbinmbarbin
authored
Merge pull request #145 from mbarbin/prepare-mdexp
Prepare mdexp
2 parents 1fa2930 + dece66c commit ef60e42

File tree

6 files changed

+0
-134
lines changed

6 files changed

+0
-134
lines changed

‎doc/docs/explanation/dune‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +0,0 @@
1-
(mdx
2-
(package volgo-dev)
3-
(deps
4-
(package volgo)
5-
(package volgo-vcs))
6-
(preludes prelude.txt))

‎doc/docs/explanation/exploratory-tests.md‎

Lines changed: 0 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -15,130 +15,3 @@ The `volgo-vcs` CLI is designed primarily for **exploratory testing and debuggin
1515
**Development standards**: This CLI component is generally developed with slightly less rigorous stability standards compared to the user-facing library APIs (such as `Vcs`, `Volgo`, etc.). While the code is thoroughly tested and functional, it remains somewhat experimental. You may encounter rough edges or behaviors that differ from your expectations.
1616

1717
**We welcome your feedback!** If you encounter issues, unexpected behaviors, or have suggestions for improvements, please don't hesitate to [open an issue](https://github.com/mbarbin/vcs/issues) on GitHub. Your bug reports and feedback help us improve this tool.
18-
19-
:::
20-
21-
Below is a quick overview of the commands available in `volgo-vcs`:
22-
23-
```bash
24-
$ volgo-vcs --help=plain
25-
NAME
26-
volgo-vcs - Call a command from the Vcs interface.
27-
28-
SYNOPSIS
29-
volgo-vcs COMMAND …
30-
31-
This CLI is built with the Volgo libraries (Versatile OCaml Library
32-
for Git Operations). It is designed for exploratory testing and
33-
debugging of the Vcs packages.
34-
35-
36-
37-
We expect a 1:1 mapping between the functions exposed in [Vcs.S] and
38-
the sub commands exposed here, plus additional ones.
39-
40-
41-
42-
Several output formats are available via the --output-format option
43-
(json, sexp, dyn) to accommodate different workflows and tools during
44-
debugging sessions.
45-
46-
47-
48-
STABILITY NOTICE: This CLI is not intended for stable scripting. Its
49-
output format and behavior may change between releases without
50-
stability guarantees. If you encounter issues or have suggestions,
51-
please open an issue at: https://github.com/mbarbin/vcs/issues
52-
53-
COMMANDS
54-
add [OPTION]… file
55-
Add a file to the index.
56-
57-
branch-revision [--output-format=FORMAT] [OPTION]… [BRANCH]
58-
Get the revision of a branch.
59-
60-
commit [--message=MSG] [--output-format=FORMAT] [--quiet] [OPTION]…
61-
Commit a file.
62-
63-
current-branch [--output-format=FORMAT] [--opt] [OPTION]…
64-
Print the current branch.
65-
66-
current-revision [--output-format=FORMAT] [OPTION]…
67-
Print the revision of HEAD.
68-
69-
descendance [--output-format=FORMAT] [OPTION]… REV REV
70-
Print descendance relation between 2 revisions.
71-
72-
find-enclosing-repo-root [--from=path/to/dir] [--output-format=FORMAT]
73-
[--store=VAL] [OPTION]…
74-
Find the root of the enclosing-repo.
75-
76-
gca [--output-format=FORMAT] [OPTION]… [REV]…
77-
Print greatest common ancestors of revisions.
78-
79-
git [OPTION]… [ARG]…
80-
Run the git cli.
81-
82-
graph [--output-format=FORMAT] [OPTION]…
83-
Compute graph of current repo.
84-
85-
hg [OPTION]… [ARG]…
86-
Run the hg cli.
87-
88-
init [--output-format=FORMAT] [--quiet] [OPTION]… path/to/root
89-
Initialize a new repository.
90-
91-
load-file [OPTION]… path/to/file
92-
Print a file from the filesystem (aka cat).
93-
94-
log [--output-format=FORMAT] [OPTION]…
95-
Show the log of current repo.
96-
97-
ls-files [--below=PATH] [OPTION]…
98-
List versioned file.
99-
100-
name-status [--output-format=FORMAT] [OPTION]… BASE TIP
101-
Show a summary of the diff between 2 revs.
102-
103-
num-status [--output-format=FORMAT] [OPTION]… BASE TIP
104-
Show a summary of the number of lines of diff between 2 revs.
105-
106-
read-dir [--output-format=FORMAT] [OPTION]… path/to/dir
107-
Print the list of files in a directory.
108-
109-
refs [--output-format=FORMAT] [OPTION]…
110-
Show the refs of current repo.
111-
112-
rename-current-branch [OPTION]… branch
113-
Move/rename a branch to a new name.
114-
115-
save-file [OPTION]… FILE
116-
Save stdin to a file from the filesystem (aka tee).
117-
118-
set-user-config [--user.email=EMAIL] [--user.name=USER] [OPTION]…
119-
Changes some settings in the user config.
120-
121-
show-file-at-rev [--rev=REV] [OPTION]… FILE
122-
Show the contents of file at a given revision.
123-
124-
COMMON OPTIONS
125-
--help[=FMT] (default=auto)
126-
Show this help in format FMT. The value FMT must be one of auto,
127-
pager, groff or plain. With auto, the format is pager or plain
128-
whenever the TERM env var is dumb or undefined.
129-
130-
--version
131-
Show version information.
132-
133-
EXIT STATUS
134-
volgo-vcs exits with:
135-
136-
0 on success.
137-
138-
123 on indiscriminate errors reported on standard error.
139-
140-
124 on command line parsing errors.
141-
142-
125 on unexpected internal errors (bugs).
143-
144-
```

‎doc/docs/explanation/prelude.txt‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

test/mdx/dune renamed to test/toplevel/dune

File renamed without changes.

test/mdx/prelude.txt renamed to test/toplevel/prelude.txt

File renamed without changes.

test/mdx/process_output.md renamed to test/toplevel/process_output.md

File renamed without changes.

0 commit comments

Comments
 (0)