Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: cli: remove requirements in helptext #9969

Merged
merged 1 commit into from Jan 10, 2023

Conversation

rjan90
Copy link
Contributor

@rjan90 rjan90 commented Jan 6, 2023

Proposed Changes

The current lotus-worker run help text outputs the hw-requirements for some of the sealing-tasks.

lotus-worker run -h
NAME:
   lotus-worker run - Start lotus worker

USAGE:
   lotus-worker run [command options] [arguments...]

OPTIONS:
   --precommit1                  enable precommit1 (32G sectors: 1 core, 128GiB Memory) (default: true) [$LOTUS_WORKER_PRECOMMIT1]

A lot of the requirements in this text is wrong, as for example the PC1 requires 64GiB of memory, and might also use up to a single core complex (1 main core, 3 producer threads) if the FIL_PROOFS_USE_MULTICORE_SDR=1 enviroment variable is exported. I propose that we remove the the sealing hw-requirements from this helptext as there are a lot of nuances that is hard to communicate in the space available in the cli, and rather communicate them in the documentation https://lotus.filecoin.io/storage-providers/get-started/hardware-requirements/ - which has now been updated (only missing PRU/PRU2, but will update those hw-requirements on Monday):

Checklist

Before you mark the PR ready for review, please make sure that:

  • Commits have a clear commit message.
  • PR title is in the form of of <PR type>: <area>: <change being made>
    • example: fix: mempool: Introduce a cache for valid signatures
    • PR type: fix, feat, build, chore, ci, docs, perf, refactor, revert, style, test
    • area, e.g. api, chain, state, market, mempool, multisig, networking, paych, proving, sealing, wallet, deps
  • New features have usage guidelines and / or documentation updates in
  • Tests exist for new functionality or change in behavior
  • CI is green

Remove the requirements from the `lotus-worker run` cli
@rjan90 rjan90 requested a review from a team as a code owner January 6, 2023 15:52
@geoff-vball geoff-vball merged commit 8519bc2 into master Jan 10, 2023
@geoff-vball geoff-vball deleted the feat/remove-requirements branch January 10, 2023 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants