Skip to content
This repository was archived by the owner on Sep 11, 2020. It is now read-only.

Commit 681f24d

Browse files
mcuadrosmcuadros
authored
Merge pull request #384 from smola/support-docs
README: add table with supported git features
2 parents 15a23a7 + 0e5c17a commit 681f24d

File tree

2 files changed

+117
-0
lines changed

2 files changed

+117
-0
lines changed

‎COMPATIBILITY.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
Supported Capabilities
2+
======================
3+
4+
Here is a non-comprehensive table of git commands and features whose equivalent
5+
is supported by go-git.
6+
7+
| Feature | Status | Notes |
8+
|---------------------------------------|--------|-------|
9+
| **config** |
10+
| config | ✔ | Reading and modifying per-repository configuration (`.git/config`) is supported. Global configuration (`$HOME/.gitconfig`) is not. |
11+
| **getting and creating repositories** |
12+
| init | ✔ | Plain init and `--bare` are supported. Flags `--template`, `--separate-git-dir` and `--shared` are not. |
13+
| clone | ✔ | Plain clone and equivalents to `--progress`, `--single-branch`, `--depth`, `--origin`, `--recurse-submodules` are supported. Others are not. |
14+
| **basic snapshotting** |
15+
| add | ✔ | Plain add is supported. Any other flag aren't supported |
16+
| status | ✔ |
17+
| commit | ✔ |
18+
| reset | ✔ |
19+
| rm | ✖ |
20+
| mv | ✖ |
21+
| **branching and merging** |
22+
| branch | ✔ |
23+
| checkout | ✔ | Basic usages of checkout are supported. |
24+
| merge | ✖ |
25+
| mergetool | ✖ |
26+
| stash | ✖ |
27+
| tag | ✔ |
28+
| **sharing and updating projects** |
29+
| fetch | ✔ |
30+
| pull | ✔ |
31+
| push | ✔ |
32+
| remote | ✔ |
33+
| submodule | ✔ |
34+
| **inspection and comparison** |
35+
| show | ✔ |
36+
| log | ✔ |
37+
| shortlog | (see log) |
38+
| describe | |
39+
| **patching** |
40+
| apply | ✖ |
41+
| cherry-pick | ✖ |
42+
| diff | ✖ |
43+
| rebase | ✖ |
44+
| revert | ✖ |
45+
| **debugging** |
46+
| bisect | ✖ |
47+
| blame | ✔ |
48+
| grep | ✖ |
49+
| **email** ||
50+
| am | ✖ |
51+
| apply | ✖ |
52+
| format-patch | ✖ |
53+
| send-email | ✖ |
54+
| request-pull | ✖ |
55+
| **external systems** |
56+
| svn | ✖ |
57+
| fast-import | ✖ |
58+
| **administration** |
59+
| clean | ✖ |
60+
| gc | ✖ |
61+
| fsck | ✖ |
62+
| reflog | ✖ |
63+
| filter-branch | ✖ |
64+
| instaweb | ✖ |
65+
| archive | ✖ |
66+
| bundle | ✖ |
67+
| prune | ✖ |
68+
| repack | ✖ |
69+
| **server admin** |
70+
| daemon | |
71+
| update-server-info | |
72+
| **advanced** |
73+
| notes | ✖ |
74+
| replace | ✖ |
75+
| worktree | ✖ |
76+
| annotate | (see blame) |
77+
| **gpg** |
78+
| git-verify-commit | ✖ |
79+
| git-verify-tag | ✖ |
80+
| **plumbing commands** |
81+
| cat-file | ✔ |
82+
| check-ignore | |
83+
| commit-tree | |
84+
| count-objects | |
85+
| diff-index | |
86+
| for-each-ref | ✔ |
87+
| hash-object | ✔ |
88+
| ls-files | ✔ |
89+
| merge-base | |
90+
| read-tree | |
91+
| rev-list | ✔ |
92+
| rev-parse | |
93+
| show-ref | ✔ |
94+
| symbolic-ref | ✔ |
95+
| update-index | |
96+
| update-ref | |
97+
| verify-pack | |
98+
| write-tree | |
99+
| **protocols** |
100+
| http(s):// (dumb) | ✖ |
101+
| http(s):// (smart) | ✔ |
102+
| git:// | ✔ |
103+
| ssh:// | ✔ |
104+
| file:// | ✔ |
105+
| custom | ✔ |
106+
| **other features** |
107+
| gitignore | ✖ |
108+
| gitattributes | ✖ |
109+
| index version | |
110+
| packfile version | |
111+
| push-certs | ✖ |

‎README.md

+6
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,12 @@ Date: Fri Nov 11 13:23:22 2016 +0100
111111

112112
You can find this [example](_examples/log/main.go) and many other at the [examples](_examples) folder
113113

114+
Comparison With Git
115+
-------------------
116+
117+
In the [compatibility documentation](COMPATIBILITY.md) you can find a comparison
118+
table of git with go-git.
119+
114120
Contribute
115121
----------
116122

0 commit comments

Comments
 (0)