Capitalized `NOTE`, first letter of following word
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Apr 29, 2016 at 16:57 UTC
f60ae0a1b97e69ee7a41c577a2e5fcad56e8fc33
29 files changed
+36
-36
Godeps/_workspace/src/bazil.org/fuse/fs/serve.go
+1
-1
@@ -774,7 +774,7 @@ func (c *serveConn) serve(r fuse.Request) {
774
775
switch r := r.(type) {
776
default:
777
- // Note: To FUSE, ENOSYS means "this server never implements this request."
777
+ // NOTE: To FUSE, ENOSYS means "this server never implements this request."
778
// It would be inappropriate to return ENOSYS for other operations in this
779
// switch that might only be unavailable in some contexts, not all.
780
done(fuse.ENOSYS)
Godeps/_workspace/src/github.com/cenkalti/backoff/exponential.go
+2
-2
@@ -19,13 +19,13 @@ percentage below and above the retry interval. For example, using 2 seconds as t
19
interval and 0.5 as the randomization factor, the actual back off period used in the next retry
20
attempt will be between 1 and 3 seconds.
21
22
-Note: max_interval caps the retry_interval and not the randomized_interval.
22
+NOTE: max_interval caps the retry_interval and not the randomized_interval.
23
24
If the time elapsed since an ExponentialBackOff instance is created goes past the
25
max_elapsed_time then the method NextBackOff() starts returning backoff.Stop.
26
The elapsed time can be reset by calling Reset().
27
28
-Example: The default retry_interval is .5 seconds, default randomization_factor is 0.5, default
28
+EXAMPLE: The default retry_interval is .5 seconds, default randomization_factor is 0.5, default
29
multiplier is 1.5 and the default max_interval is 1 minute. For 10 tries the sequence will be
30
(values in seconds) and assuming we go over the max_elapsed_time on the 10th try:
31
Godeps/_workspace/src/github.com/cheggaaa/pb/pb.go
+1
-1
@@ -145,7 +145,7 @@ func (pb *ProgressBar) Postfix(postfix string) *ProgressBar {
145
}
146
147
// Set custom format for bar
148
-// Example: bar.Format("[=>_]")
148
+// EXAMPLE: bar.Format("[=>_]")
149
func (pb *ProgressBar) Format(format string) *ProgressBar {
150
formatEntries := strings.Split(format, "")
151
if len(formatEntries) == 5 {
Godeps/_workspace/src/github.com/codegangsta/cli/app.go
+2
-2
@@ -56,9 +56,9 @@ type App struct {
56
Authors []Author
57
// Copyright of the binary if any
58
Copyright string
59
- // Name of Author (Note: Use App.Authors, this is deprecated)
59
+ // Name of Author (NOTE: Use App.Authors, this is deprecated)
60
Author string
61
- // Email of Author (Note: Use App.Authors, this is deprecated)
61
+ // Email of Author (NOTE: Use App.Authors, this is deprecated)
62
Email string
63
// Writer writer to write output to
64
Writer io.Writer
Godeps/_workspace/src/github.com/ipfs/go-datastore/leveldb/datastore.go
+1
-1
@@ -33,7 +33,7 @@ func NewDatastore(path string, opts *Options) (*datastore, error) {
33
34
// Returns ErrInvalidType if value is not of type []byte.
35
//
36
-// Note: using sync = false.
36
+// NOTE: Using sync = false.
37
// see http://godoc.org/github.com/syndtr/goleveldb/leveldb/opt#WriteOptions
38
func (d *datastore) Put(key ds.Key, value interface{}) (err error) {
39
val, ok := value.([]byte)
Godeps/_workspace/src/github.com/ipfs/go-datastore/namespace/namespace.go
+1
-1
@@ -12,7 +12,7 @@ import (
12
// PrefixTransform constructs a KeyTransform with a pair of functions that
13
// add or remove the given prefix key.
14
//
15
-// Warning: will panic if prefix not found when it should be there. This is
15
+// Warning: Will panic if prefix not found when it should be there. This is
16
// to avoid insidious data inconsistency errors.
17
func PrefixTransform(prefix ds.Key) ktds.KeyTransform {
18
return &ktds.Pair{
Godeps/_workspace/src/github.com/rs/cors/cors.go
+1
-1
@@ -93,7 +93,7 @@ func New(options Options) *Cors {
93
}
94
95
// Normalize options
96
- // Note: for origins and methods matching, the spec requires a case-sensitive matching.
96
+ // NOTE: For origins and methods matching, the spec requires a case-sensitive matching.
97
// As it may error prone, we chose to ignore the spec here.
98
99
// Allowed Origins
Godeps/_workspace/src/github.com/syndtr/gosnappy/snappy/snappy_test.go
+1
-1
@@ -241,7 +241,7 @@ func expand(src []byte, n int) []byte {
241
}
242
243
func benchWords(b *testing.B, n int, decode bool) {
244
- // Note: the file is OS-language dependent so the resulting values are not
244
+ // NOTE: The file is OS-language dependent so the resulting values are not
245
// directly comparable for non-US-English OS installations.
246
data := expand(readFile(b, "/usr/share/dict/words"), n)
247
if decode {
Godeps/_workspace/src/gopkg.in/fsnotify.v1/open_mode_darwin.go
+1
-1
@@ -8,5 +8,5 @@ package fsnotify
8
9
import "syscall"
10
11
-// note: this constant is not defined on BSD
11
+// note: This constant is not defined on BSD
12
const openMode = syscall.O_EVTONLY
core/commands/files/files.go
+4
-4
@@ -28,7 +28,7 @@ var FilesCmd = &cmds.Command{
28
ShortDescription: `
29
Files is an API for manipulating IPFS objects as if they were a unix filesystem.
30
31
-Note:
31
+NOTE:
32
Most of the subcommands of 'ipfs files' accept the '--flush' flag. It defaults to
33
true. Use caution when setting this flag to false. It will improve performance
34
for large numbers of file operations, but it does so at the cost of consistency
@@ -499,12 +499,12 @@ If the '--flush' option is set to false, changes will not be propogated to the
499
merkledag root. This can make operations much faster when doing a large number
500
of writes to a deeper directory structure.
501
502
-Example:
502
+EXAMPLE:
503
504
echo "hello world" | ipfs files write --create /myfs/a/b/file
505
echo "hello world" | ipfs files write --truncate /myfs/a/b/file
506
507
-Warning:
507
+WARNING:
508
509
Usage of the '--flush=false' option does not guarantee data durability until
510
the tree has been flushed. This can be accomplished by running 'ipfs files stat'
@@ -616,7 +616,7 @@ var FilesMkdirCmd = &cmds.Command{
616
ShortDescription: `
617
Create the directory if it does not already exist.
618
619
-Note: All paths must be absolute.
619
+NOTE: All paths must be absolute.
620
621
Examples:
622
core/commands/object/patch.go
+1
-1
@@ -52,7 +52,7 @@ Example:
52
53
$ echo "hello" | ipfs object patch $HASH append-data
54
55
-Note: This does not append data to a file - it modifies the actual raw
55
+NOTE: This does not append data to a file - it modifies the actual raw
56
data within an object. Objects have a max size of 1MB and objects larger than
57
the limit will not be respected by the network.
58
`,
core/commands/refs.go
+1
-1
@@ -40,7 +40,7 @@ with the following format:
40
41
<link base58 hash>
42
43
-Note: List all references recursively by using the flag '-r'.
43
+NOTE: List all references recursively by using the flag '-r'.
44
`,
45
},
46
Subcommands: map[string]*cmds.Command{
core/core.go
+1
-1
@@ -323,7 +323,7 @@ func (n *IpfsNode) teardown() error {
323
// regardless of which constructor was used to add them to the node.
324
var closers []io.Closer
325
326
- // NOTE: the order that objects are added(closed) matters, if an object
326
+ // NOTE: The order that objects are added(closed) matters, if an object
327
// needs to use another during its shutdown/cleanup process, it should be
328
// closed before that other object
329
docs/fuse.md
+1
-1
@@ -48,7 +48,7 @@ You may also have to change `/dev/fuse`:
48
sudo chown <username>:<groupname> /dev/fuse
49
```
50
51
-Note: `<groupname>` will usually be `fuse`. Typically, you add the authorized users to the `fuse` group:
51
+NOTE: `<groupname>` will usually be `fuse`. Typically, you add the authorized users to the `fuse` group:
52
53
```sh
54
sudo usermod -a -G fuse <username>
docs/implement-api-bindings.md
+2
-2
@@ -31,7 +31,7 @@ In the commandline, IPFS uses a traditional flag and arg-based mapping, where:
31
- the rest are positional arguments - e.g. `ipfs object patch <hash1> add-link foo <hash2>`
32
- files are specified by filename, or through stdin
33
34
-(NOTE: when go-ipfs runs the daemon, the CLI API is actually converted to HTTP calls. otherwise, they execute in the same process)
34
+(NOTE: When go-ipfs runs the daemon, the CLI API is actually converted to HTTP calls. otherwise, they execute in the same process)
35
36
### HTTP API Transport
37
@@ -47,7 +47,7 @@ In HTTP, our API layering uses a REST-like mapping, where:
47
48
There is a "standard IPFS API" with a set of commands, which we are documenting clearly soon. But this is not yet extracted into its own document. Perhaps -- as part of this API Bindings effort -- we can document it all. It is currently defined as "all the commands exposed by the go-ipfs implementation". You can see [a listing here](https://github.com/ipfs/go-ipfs/blob/916f987de2c35db71815b54bbb9a0a71df829838/core/commands/root.go#L82-L111), or by running `ipfs commands` locally. **The good news is: we should be able to easily write a program that outputs a markdown API specification!**
49
50
-(Note: the go-ipfs [commands library](https://github.com/ipfs/go-ipfs/tree/916f987de2c35db71815b54bbb9a0a71df829838/commands) also makes sure to keep the CLI and the HTTP API exactly in sync.)
50
+(NOTE: The go-ipfs [commands library](https://github.com/ipfs/go-ipfs/tree/916f987de2c35db71815b54bbb9a0a71df829838/commands) also makes sure to keep the CLI and the HTTP API exactly in sync.)
51
52
## Implementing bindings for the HTTP API
53
fuse/node/mount_darwin.go
+1
-1
@@ -29,7 +29,7 @@ var fuseVersionPkg = "github.com/jbenet/go-fuse-version/fuse-version"
29
var errStrFuseRequired = `OSXFUSE not found.
30
31
OSXFUSE is required to mount, please install it.
32
-Note: version 2.7.2 or higher required; prior versions are known to kernel panic!
32
+NOTE: Version 2.7.2 or higher required; prior versions are known to kernel panic!
33
It is recommended you install it from the OSXFUSE website:
34
35
http://osxfuse.github.io/
merkledag/node.go
+2
-2
@@ -165,7 +165,7 @@ func (n *Node) GetLinkedNode(ctx context.Context, ds DAGService, name string) (*
165
}
166
167
// Copy returns a copy of the node.
168
-// NOTE: does not make copies of Node objects in the links.
168
+// NOTE: Does not make copies of Node objects in the links.
169
func (n *Node) Copy() *Node {
170
nnode := new(Node)
171
if len(n.Data) > 0 {
@@ -234,7 +234,7 @@ func (n *Node) Stat() (*NodeStat, error) {
234
235
// Multihash hashes the encoded data of this node.
236
func (n *Node) Multihash() (mh.Multihash, error) {
237
- // Note: EncodeProtobuf generates the hash and puts it in n.cached.
237
+ // NOTE: EncodeProtobuf generates the hash and puts it in n.cached.
238
_, err := n.EncodeProtobuf(false)
239
if err != nil {
240
return nil, err
pin/pin_test.go
+1
-1
@@ -213,7 +213,7 @@ func TestPinRecursiveFail(t *testing.T) {
213
t.Fatal(err)
214
}
215
216
- // Note: this isnt a time based test, we expect the pin to fail
216
+ // NOTE: This isnt a time based test, we expect the pin to fail
217
mctx, _ := context.WithTimeout(ctx, time.Millisecond)
218
err = p.Pin(mctx, a, true)
219
if err == nil {
repo/config/bootstrap_peers.go
+1
-1
@@ -11,7 +11,7 @@ import (
11
// for ipfs. they are nodes run by the ipfs team. docs on these later.
12
// As with all p2p networks, bootstrap is an important security concern.
13
//
14
-// Note: this is here -- and not inside cmd/ipfs/init.go -- because of an
14
+// NOTE: This is here -- and not inside cmd/ipfs/init.go -- because of an
15
// import dependency issue. TODO: move this into a config/default/ package.
16
var DefaultBootstrapAddresses = []string{
17
"/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ", // mars.i.ipfs.io
repo/config/init.go
+1
-1
@@ -29,7 +29,7 @@ func Init(out io.Writer, nBitsForKeypair int) (*Config, error) {
29
conf := &Config{
30
31
// setup the node's default addresses.
32
- // Note: two swarm listen addrs, one tcp, one utp.
32
+ // NOTE: two swarm listen addrs, one tcp, one utp.
33
Addresses: Addresses{
34
Swarm: []string{
35
"/ip4/0.0.0.0/tcp/4001",
roadmap.md
+1
-1
@@ -1,5 +1,5 @@
1
# go-ipfs Q2 roadmap
2
-Note: no specific order is implied in this list
2
+NOTE: No specific order is implied in this list.
3
4
- [ ] fix random test failures
5
- check issues for label 'test_failure'
routing/dht/dht.go
+1
-1
@@ -154,7 +154,7 @@ var errInvalidRecord = errors.New("received invalid record")
154
155
// getValueOrPeers queries a particular peer p for the value for
156
// key. It returns either the value or a list of closer peers.
157
-// NOTE: it will update the dht's peerstore with any new addresses
157
+// NOTE: It will update the dht's peerstore with any new addresses
158
// it finds for the given peer.
159
func (dht *IpfsDHT) getValueOrPeers(ctx context.Context, p peer.ID,
160
key key.Key) (*pb.Record, []peer.PeerInfo, error) {
routing/dht/handlers.go
+1
-1
@@ -127,7 +127,7 @@ func (dht *IpfsDHT) checkLocalDatastore(k key.Key) (*pb.Record, error) {
127
recordIsBad = true
128
}
129
130
- // NOTE: we do not verify the record here beyond checking these timestamps.
130
+ // NOTE: We do not verify the record here beyond checking these timestamps.
131
// we put the burden of checking the records on the requester as checking a record
132
// may be computationally expensive
133
routing/dht/routing.go
+1
-1
@@ -283,7 +283,7 @@ func (dht *IpfsDHT) findProvidersAsyncRoutine(ctx context.Context, key key.Key,
283
ps := pset.NewLimited(count)
284
provs := dht.providers.GetProviders(ctx, key)
285
for _, p := range provs {
286
- // NOTE: assuming that this list of peers is unique
286
+ // NOTE: Assuming that this list of peers is unique
287
if ps.TryAdd(p) {
288
select {
289
case peerOut <- dht.peerstore.PeerInfo(p):
test/sharness/Makefile
+1
-1
@@ -4,7 +4,7 @@
4
# MIT Licensed; see the LICENSE file in this repository.
5
#
6
7
-# NOTE: run with TEST_VERBOSE=1 for verbose sharness tests.
7
+# NOTE: Run with TEST_VERBOSE=1 for verbose sharness tests.
8
9
T = $(sort $(wildcard t[0-9][0-9][0-9][0-9]-*.sh))
10
BINS = bin/random bin/multihash bin/ipfs bin/pollEndpoint \
test/sharness/t0083-repo-fsck.sh
+1
-1
@@ -13,7 +13,7 @@ test_init_ipfs
13
#############################
14
# Test without daemon running
15
#############################
16
-# Note: if api file isn't present we can assume the daemon isn't running
16
+# NOTE: if api file isn't present we can assume the daemon isn't running
17
18
# Try with all lock files present: repo.lock, api, and datastore/LOCK with
19
# repo.lock and datastore/LOCK being empty
thirdparty/loggables/loggables.go
+1
-1
@@ -2,7 +2,7 @@
2
// commonplace/stdlib objects. This is boilerplate code that shouldn't change
3
// much, and not sprinkled all over the place (i.e. gather it here).
4
//
5
-// Note: it may make sense to put all stdlib Loggable functions in the eventlog
5
+// NOTE: it may make sense to put all stdlib Loggable functions in the eventlog
6
// package. Putting it here for now in case we don't want to pollute it.
7
package loggables
8
thirdparty/testutil/ci/travis/travis.go
+1
-1
@@ -36,7 +36,7 @@ const (
36
// CI=true
37
// TRAVIS=true
38
//
39
-// Note: cannot just check CI.
39
+// NOTE: cannot just check CI.
40
func IsRunning() bool {
41
return Env(VarCI) == "true" && Env(VarTravis) == "true"
42
}
thirdparty/testutil/gen.go
+1
-1
@@ -61,7 +61,7 @@ func RandPeerIDFatal(t testing.TB) peer.ID {
61
// RandLocalTCPAddress returns a random multiaddr. it suppresses errors
62
// for nice composability-- do check the address isn't nil.
63
//
64
-// Note: for real network tests, use ZeroLocalTCPAddress so the kernel
64
+// NOTE: for real network tests, use ZeroLocalTCPAddress so the kernel
65
// assigns an unused TCP port. otherwise you may get clashes. This
66
// function remains here so that p2p/net/mock (which does not touch the
67
// real network) can assign different addresses to peers.