document the config options

[whyrusleeping]

cc @RichardLitt @lgierth @Kubuxu

License: MIT
Signed-off-by: Jeromy [email protected]

[Kubuxu]

Option added in: #2973 is missing as well as #2904.

[RichardLitt]

Capitalize API consistently. Same for HTTP.

[RichardLitt]

Added some small comments. Mostly good.

Add a Table of Contents.

[whyrusleeping]

@RichardLitt PRs welcome ;)

[RichardLitt]

I am really unhappy, because I have no idea why there is a merge commit in here. I tried this:

$ git branch
> master
$ git checkout feat/config-docs
> merge commit??
$ git checkout <sha of @whyrusleeping's commit>
> on detached branch
$ <edit files>
$ git add -A && git commit -m 'My changes'
> Add stuff
$ git checkout feat/config-docs
> left commit behind
$ git branch new-branch <sha of new commit with edits>
$ git checkout new-branch
$ git rebase feat/config-docs
$ git checkout feat/config-docs
$ git merge new-branch
$ git log
> commit 7866ede31ff2e5177a710600cb02d36a931aa123
Author: Richard Littauer <[email protected]>
Date:   Tue Jul 19 12:40:39 2016 +0100

    Capitalized acronyms, add ToC

    License: MIT
    Signed-off-by: Richard Littauer <[email protected]>

commit f94d1f412626fc1f5c2bb04813306969e30af844
Merge: 0c7ba07 0e4c195
Author: Richard Littauer <[email protected]>
Date:   Tue Jul 19 12:35:16 2016 +0100

    Merge https://github.com/ipfs/go-ipfs into feat/config-docs

commit 0e4c19558fcec59dc69ddab695f55baf094b80c6
Merge: 8fbbd7f 228c4db
Author: Jeromy Johnson <[email protected]>
Date:   Mon Jul 18 06:20:49 2016 -0700

    Merge pull request #2975 from djdv/makefile-win-fix

    Build: Fix Makefile on Windows

commit 0c7ba070293a3e359d340c4be531780aeff63603
Author: Jeromy <[email protected]>
Date:   Sun Jul 17 09:18:20 2016 -0700

    add newer config options and reformat

    License: MIT
    Signed-off-by: Jeromy <[email protected]>

So confused right now.

[Kubuxu]

to fix:

git fetch
git checkout master
git pull
git checkout feat/config-docs
git rebase master

done it already

[RichardLitt]

Thank you, @Kubuxu

[whyrusleeping]

RFM?

[RichardLitt]

RFM.

[jbenet]

• This is a great to have 👍
• It could use more examples
• Or be written as a big json file with comments next to the keys/values (config_doc.js for syntax highlighting) similar to how various sys configs are written
• reconsider using hson...