Initial version of ipfs-pump #1
Conversation
|
The money shot 🎉 :
|
LICENSE
Outdated
| @@ -0,0 +1 @@ | |||
| Just a note, some code has been lifted from go-ipfs (MIT) | |||
There was a problem hiding this comment.
To be more official about this, put it in a NOTICE file with a copypasta of go-ipfs's license verbatim. Bonus points if you describe the scope of the copied code. Personally I like to keep it isolated (e.g. in its own .go file) so that it's easy to remove/replace later.
If the borrowed piece is really small, I sometimes just put it inline. E.g. this one function (which I plan to remove eventually): https://github.com/vipnode/vipnode/blob/master/jsonrpc2/borrowed_eth.go
There was a problem hiding this comment.
Yeah, it's actually even less than that. Basically I went to look at the go-ipfs source to see how the components are articulated as there is pretty much no documentation about the internals. I can see where it has been useful, but there is pretty nothing that I can actually call "borrowed code".
There was a problem hiding this comment.
In that case, I wouldn't even bother mentioning it here but just give it a one-liner comment in the relevant place "Used X as reference to implement" kinda thing.
| enumArg = kingpin.Arg("enum", "The source to enumerate the content. "+ | ||
| "Possible values are ["+strings.Join(enumValues, ",")+"]."). | ||
| Required().Enum(enumValues...) | ||
| collValues = []string{CollAPI, CollFlatFS, CollS3} |
There was a problem hiding this comment.
FWIW: Saw a bunch of "coll" prefixes, took me a long time to figure out it was "collector" abbreviated. :P
There was a problem hiding this comment.
do you have someting more meaningful in mind ? It kind of make sense for me, but as english is not my first language sometimes I miss some stuff (and you are all very much welcome to help/correct me about it).
There was a problem hiding this comment.
I'd default to spelling out "collector" or "collect". It's not that much longer.
Coll just threw me off because it's so close to "Call" which I see all the time. It's just me though, so don't feel pressured to make the change if it looks fine to you. :)
|
@johanherman I'm curious to see how this behave with cluster ! |
|
@MichaelMure Weee! Will have a look! |
This PR introduce a first version of
ipfs-pumpthat support: