@cryptotaxi247 / kubo / commits / 733dc569d

CHANGELOG: rearrange sections

License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>

Steven Allen committed Oct 28, 2018 at 07:19 UTC 733dc569d8a7873ce75ee596c8c7bc02225f3095
1 file changed +28 -17
CHANGELOG.md
+28 -17
@@ -101,30 +101,18 @@ to 32 bytes in length into a CID, instead of writing an actual block. This
101 should significantly reduce the size of filesystem trees with many empty
102 directories and tiny files.
103
104 -#### CoreAPI
105 -
106 -CoreAPI is a new way to interact with IPFS from Go. While it's still not
107 -final, most things you can do via the CLI or HTTP interfaces, can now be done
108 -through the new API.
109 -
110 -Currently there is only one implementation, backed by go-ipfs node, and there are
111 -plans to start http-api backed one soon. We are also looking into creating RPC
112 -interface using this API, which could help performance in some use cases.
113 -
114 -You can track progress in https://github.com/ipfs/go-ipfs/issues/4498
115 -
104 #### WebUI
105
106 Finally, this release includes the shiny [updated
107 webui](https://github.com/ipfs-shipyard/ipfs-webui). You can view it by
108 installing go-ipfs and visiting http://localhost:5001/webui.
109
122 -#### Performance
110 +### Performance
111
112 This release includes some significant performance improvements, both in terms
113 of resource utilization and speed.
114
127 -##### Resource Utilization
115 +#### Resource Utilization
116
117 In this release, we've (a) fixed a slow memory leak in libp2p and (b)
118 significantly reduced the allocation load. Together, these should improve both
@@ -138,18 +126,41 @@ memory and CPU usage.
126 * Yamux buffering
127 * ...
128
141 -##### Bitswap Performance
129 +#### Bitswap Performance
130
131 TODO: Multiple blocks per message. Could someone test this? Basic tests showed
132 some improvements for small files but I'd like to see some numbers.
133
146 -##### Async Directory Listing V1
134 +#### Async Directory Listing V1
135
136 (v2 will make it into the next release)
137
138 TODO
139
152 -#### Effort towards Migration to CIDv1/Base32
140 +### Efforts
141 +
142 +#### Commands Lib
143 +
144 +We've completely refactored our commands library (again). While it still needs
145 +quite a bit of work, it now requires significantly less boilerplate and should
146 +be significantly more robust. The refactor immediately found two broken tests
147 +and probably fixed quite a few bugs around properly returning and handling
148 +errors.
149 +
150 +#### CoreAPI
151 +
152 +CoreAPI is a new way to interact with IPFS from Go. While it's still not
153 +final, most things you can do via the CLI or HTTP interfaces, can now be done
154 +through the new API.
155 +
156 +Currently there is only one implementation, backed by go-ipfs node, and there are
157 +plans to start http-api backed one soon. We are also looking into creating RPC
158 +interface using this API, which could help performance in some use cases.
159 +
160 +You can track progress in https://github.com/ipfs/go-ipfs/issues/4498
161 +
162 +
163 +#### CIDv1/Base32 Migration
164
165 FIXME: Someone in charge of the DWEB effort should review and edit this section.
166