diff options
| author | Máximo Cuadros <mcuadros@gmail.com> | 2017-05-12 15:16:17 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-12 15:16:17 +0200 |
| commit | 681f24d65046397228b4e4bb4e248fdb1e27f347 (patch) | |
| tree | 897c2f6161a5f054dd52d76edffa29bf4da820df | |
| parent | 15a23a7622978f0c5d74a381782a3c7da97016da (diff) | |
| parent | 0e5c17a853aeff26cc1cd97a2226e31526ab2ce5 (diff) | |
| download | go-git-681f24d65046397228b4e4bb4e248fdb1e27f347.tar.gz | |
Merge pull request #384 from smola/support-docs
README: add table with supported git features
| -rw-r--r-- | COMPATIBILITY.md | 111 | ||||
| -rw-r--r-- | README.md | 6 |
2 files changed, 117 insertions, 0 deletions
diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md new file mode 100644 index 0000000..81ff6b6 --- /dev/null +++ b/COMPATIBILITY.md @@ -0,0 +1,111 @@ +Supported Capabilities +====================== + +Here is a non-comprehensive table of git commands and features whose equivalent +is supported by go-git. + +| Feature | Status | Notes | +|---------------------------------------|--------|-------| +| **config** | +| config | ✔ | Reading and modifying per-repository configuration (`.git/config`) is supported. Global configuration (`$HOME/.gitconfig`) is not. | +| **getting and creating repositories** | +| init | ✔ | Plain init and `--bare` are supported. Flags `--template`, `--separate-git-dir` and `--shared` are not. | +| clone | ✔ | Plain clone and equivalents to `--progress`, `--single-branch`, `--depth`, `--origin`, `--recurse-submodules` are supported. Others are not. | +| **basic snapshotting** | +| add | ✔ | Plain add is supported. Any other flag aren't supported | +| status | ✔ | +| commit | ✔ | +| reset | ✔ | +| rm | ✖ | +| mv | ✖ | +| **branching and merging** | +| branch | ✔ | +| checkout | ✔ | Basic usages of checkout are supported. | +| merge | ✖ | +| mergetool | ✖ | +| stash | ✖ | +| tag | ✔ | +| **sharing and updating projects** | +| fetch | ✔ | +| pull | ✔ | +| push | ✔ | +| remote | ✔ | +| submodule | ✔ | +| **inspection and comparison** | +| show | ✔ | +| log | ✔ | +| shortlog | (see log) | +| describe | | +| **patching** | +| apply | ✖ | +| cherry-pick | ✖ | +| diff | ✖ | +| rebase | ✖ | +| revert | ✖ | +| **debugging** | +| bisect | ✖ | +| blame | ✔ | +| grep | ✖ | +| **email** || +| am | ✖ | +| apply | ✖ | +| format-patch | ✖ | +| send-email | ✖ | +| request-pull | ✖ | +| **external systems** | +| svn | ✖ | +| fast-import | ✖ | +| **administration** | +| clean | ✖ | +| gc | ✖ | +| fsck | ✖ | +| reflog | ✖ | +| filter-branch | ✖ | +| instaweb | ✖ | +| archive | ✖ | +| bundle | ✖ | +| prune | ✖ | +| repack | ✖ | +| **server admin** | +| daemon | | +| update-server-info | | +| **advanced** | +| notes | ✖ | +| replace | ✖ | +| worktree | ✖ | +| annotate | (see blame) | +| **gpg** | +| git-verify-commit | ✖ | +| git-verify-tag | ✖ | +| **plumbing commands** | +| cat-file | ✔ | +| check-ignore | | +| commit-tree | | +| count-objects | | +| diff-index | | +| for-each-ref | ✔ | +| hash-object | ✔ | +| ls-files | ✔ | +| merge-base | | +| read-tree | | +| rev-list | ✔ | +| rev-parse | | +| show-ref | ✔ | +| symbolic-ref | ✔ | +| update-index | | +| update-ref | | +| verify-pack | | +| write-tree | | +| **protocols** | +| http(s):// (dumb) | ✖ | +| http(s):// (smart) | ✔ | +| git:// | ✔ | +| ssh:// | ✔ | +| file:// | ✔ | +| custom | ✔ | +| **other features** | +| gitignore | ✖ | +| gitattributes | ✖ | +| index version | | +| packfile version | | +| push-certs | ✖ |
\ No newline at end of file @@ -111,6 +111,12 @@ Date: Fri Nov 11 13:23:22 2016 +0100 You can find this [example](_examples/log/main.go) and many other at the [examples](_examples) folder +Comparison With Git +------------------- + +In the [compatibility documentation](COMPATIBILITY.md) you can find a comparison +table of git with go-git. + Contribute ---------- |