lotus-miner: Cleanup storage attach helptext a bit

This commit is contained in:
Łukasz Magiera 2020-10-03 00:34:09 +02:00
parent c66f087f4c
commit 1fc23fb466
2 changed files with 21 additions and 17 deletions

View File

@ -31,9 +31,10 @@ const metaFile = "sectorstore.json"
var storageCmd = &cli.Command{
Name: "storage",
Usage: "manage sector storage",
Description: `Sectors can be stored across many filesystem paths. These commands provide ways to
manage the storage the miner will used to store sectors long term for proving (refernces as 'store')
as well as how sectors will be stored while moving through the sealing pipeline (references as 'seal').`,
Description: `Sectors can be stored across many filesystem paths. These
commands provide ways to manage the storage the miner will used to store sectors
long term for proving (references as 'store') as well as how sectors will be
stored while moving through the sealing pipeline (references as 'seal').`,
Subcommands: []*cli.Command{
storageAttachCmd,
storageListCmd,
@ -44,21 +45,24 @@ var storageCmd = &cli.Command{
var storageAttachCmd = &cli.Command{
Name: "attach",
Usage: "attach local storage path",
Description: `Storage can be attach to the miner using this command. The storage volume list is stored local
to the miner in $LOTUS_MINER_PATH/storage.json. We do not recommend modifying this value without further
understanding of the storage system.
Description: `Storage can be attached to the miner using this command. The storage volume
list is stored local to the miner in $LOTUS_MINER_PATH/storage.json. We do not
recommend manually modifying this value without further understanding of the
storage system.
Each storage volume contains a configuration file which descripbes the capabilities of the volume. When the
'--init' flag is provided, this file will be created using the additional flags.
Each storage volume contains a configuration file which describes the
capabilities of the volume. When the '--init' flag is provided, this file will
be created using the additional flags.
Weight
A high weight value means data will be more likely to be stored
Weight
A high weight value means data will be more likely to be stored in this path
Seal
Intermittment data for the sealing process will be stored here
Seal
Data for the sealing process will be stored here
Store
Finalized sectors that will be proved over will be stored here
Store
Finalized sectors that will be moved here for long term storage and be proven
over time
`,
Flags: []cli.Flag{
&cli.BoolFlag{

View File

@ -32,13 +32,13 @@ type StoragePath struct {
type LocalStorageMeta struct {
ID ID
// A height wait means data is more likely to be stored here
// A high weight means data is more likely to be stored in this path
Weight uint64 // 0 = readonly
// Intermittment data for the sealing process will be stored here
// Intermediate data for the sealing process will be stored here
CanSeal bool
// Finalized sectors that will be proved over will be stored here
// Finalized sectors that will be proved over time will be stored here
CanStore bool
}