diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contribute.mdwn | 12 | ||||
| -rw-r--r-- | doc/design/git-remote-daemon.mdwn | 8 | ||||
| -rw-r--r-- | doc/index.mdwn | 3 |
3 files changed, 19 insertions, 4 deletions
diff --git a/doc/contribute.mdwn b/doc/contribute.mdwn new file mode 100644 index 000000000..5dc3eb5ed --- /dev/null +++ b/doc/contribute.mdwn @@ -0,0 +1,12 @@ +Help make git-annex better! + +* This website is a wiki, so you can edit and improve any page. +* Write a [[new_tip|tips]] explaining how to accomplish something with + git-annex. +* [[download]] the source code and send patches! +* If you know Haskell, git-annex has lots of Haskell code that + could be improved. See the [[coding_style]] and have at it. +* If you don't know Haskell, git-annex has many other coding opportunities. + You could work to improve the Android port (Java etc) or improve the + Javascript and CSS of the git-annex webapp, or work on porting libraries + needed by the Windows port. diff --git a/doc/design/git-remote-daemon.mdwn b/doc/design/git-remote-daemon.mdwn index db56bd633..6b8e0646f 100644 --- a/doc/design/git-remote-daemon.mdwn +++ b/doc/design/git-remote-daemon.mdwn @@ -82,7 +82,7 @@ the webapp. Indicates that a pull or a push with a remote is in progress. Always followed by DONESYNCING. -* `DONESYNCING $remote 1|0` +* `DONESYNCING 1|0 $remote` Indicates that syncing with a remote is done, and either succeeded (1) or failed (0). @@ -114,6 +114,10 @@ the webapp. Indicates that configs have changed. Daemon should reload .git/config and/or restart. + Possible config changes include adding a new remote, removing a remote, + or setting `remote.<name>.annex-sync` to configure whether to sync with a + particular remote. + * `STOP` Shut down git-remote-daemon @@ -156,8 +160,6 @@ No pushing is done for CHANGED, since git handles ssh natively. TODO: -* It already detects changes and pulls, but it then dies with a protocol - error. * Remote system might not be available. Find a smart way to detect it, ideally w/o generating network traffic. One way might be to check if the ssh connection caching control socket exists, for example. diff --git a/doc/index.mdwn b/doc/index.mdwn index 57bfe2408..9536ee148 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -39,7 +39,8 @@ files with git. ---- -git-annex is [[Free Software|license]] +git-annex is [[Free Software|license]], written in Haskell. +You can [[contribute]]! git-annex's wiki is powered by [Ikiwiki](http://ikiwiki.info/) and hosted by [Branchable](http://branchable.com/). |