aboutsummaryrefslogtreecommitdiffstats
path: root/COMPATIBILITY.md
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2017-05-12 15:16:17 +0200
committerGitHub <noreply@github.com>2017-05-12 15:16:17 +0200
commit681f24d65046397228b4e4bb4e248fdb1e27f347 (patch)
tree897c2f6161a5f054dd52d76edffa29bf4da820df /COMPATIBILITY.md
parent15a23a7622978f0c5d74a381782a3c7da97016da (diff)
parent0e5c17a853aeff26cc1cd97a2226e31526ab2ce5 (diff)
downloadgo-git-681f24d65046397228b4e4bb4e248fdb1e27f347.tar.gz
Merge pull request #384 from smola/support-docs
README: add table with supported git features
Diffstat (limited to 'COMPATIBILITY.md')
-rw-r--r--COMPATIBILITY.md111
1 files changed, 111 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