Skip to content

Commit 878a416

Browse files
authored
README clarifications & nits (textileio#478)
* improve cidlogger message Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com> * some readme clarifications Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com> * less restrictive Go versioning Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com> * reduce CI noise Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
1 parent ec0da08 commit 878a416

4 files changed

Lines changed: 9 additions & 5 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ docs-pow:
2121
.PHONY: docs-pow
2222

2323
test:
24-
go test -short -parallel 8 -race -timeout 30m ./...
24+
go test -short -parallel 6 -race -timeout 30m ./...
2525
.PHONY: test
2626

2727
clean-protos:

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Join us on our [public Slack channel](https://slack.textile.io/) for news, discu
1414

1515
## Table of Contents
1616

17+
- [Prerequisites](#prerequisites)
1718
- [Design](#design)
1819
- [Installation](#installation)
1920
- [Devnet mode](#devnet-mode)
@@ -24,6 +25,10 @@ Join us on our [public Slack channel](https://slack.textile.io/) for news, discu
2425
- [Changelog](#changelog)
2526
- [License](#license)
2627

28+
## Prerequisites
29+
30+
To build from source, you need to have Go 1.14 or newer installed.
31+
2732
## Design
2833

2934
Powergate is composed of different modules which can be used independently, and compose toegheter to provide other higher-level modules.
@@ -60,6 +65,7 @@ To build and install the CLI, run:
6065
```bash
6166
$ make build-pow
6267
```
68+
The binary will be placed automatically in `$GOPATH/bin` which in general is in `$PATH`, so you can immediately run `pow` in your terminal.
6369

6470
You can read the [generated CLI docs](https://github.com/textileio/powergate/blob/master/cli-docs/pow/pow.md) in this repo, or run `pow` with the `--help` flag to see the available commands:
6571

ffs/integrationtest/integration_test.go

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1308,8 +1308,6 @@ func TestParallelExecution(t *testing.T) {
13081308
}
13091309

13101310
func TestJobCancellation(t *testing.T) {
1311-
t.Parallel()
1312-
13131311
r := rand.New(rand.NewSource(22))
13141312
ipfsAPI, _, fapi, cls := newAPI(t, 1)
13151313
defer cls()

ffs/scheduler/scheduler.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -493,15 +493,15 @@ func (s *Scheduler) execute(ctx context.Context, a astore.Action, job ffs.Job) (
493493

494494
func (s *Scheduler) executeHotStorage(ctx context.Context, curr ffs.CidInfo, cfg ffs.HotConfig, waddr string, replaceCid cid.Cid) (ffs.HotInfo, error) {
495495
if cfg.Enabled == curr.Hot.Enabled {
496-
s.l.Log(ctx, curr.Cid, "Current Cid state is healthy in Hot-Storage.")
496+
s.l.Log(ctx, curr.Cid, "No actions needed in Hot Storage.")
497497
return curr.Hot, nil
498498
}
499499

500500
if !cfg.Enabled {
501501
if err := s.hs.Remove(ctx, curr.Cid); err != nil {
502502
return ffs.HotInfo{}, fmt.Errorf("removing from hot storage: %s", err)
503503
}
504-
s.l.Log(ctx, curr.Cid, "Cid successfully removed from Hot-Storage.")
504+
s.l.Log(ctx, curr.Cid, "Cid successfully removed from Hot Storage.")
505505
return ffs.HotInfo{Enabled: false}, nil
506506
}
507507

0 commit comments

Comments
 (0)