From 9310f166e2f0811ff4f6af276d2270a8efa824e5 Mon Sep 17 00:00:00 2001 From: manasnagaraj Date: Wed, 25 Sep 2024 11:25:27 -0400 Subject: [PATCH 1/7] cli description --- validator_manager/src/create_validators.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/validator_manager/src/create_validators.rs b/validator_manager/src/create_validators.rs index d06fce1d094..abd98e86901 100644 --- a/validator_manager/src/create_validators.rs +++ b/validator_manager/src/create_validators.rs @@ -112,7 +112,9 @@ pub fn cli_app() -> Command { "When provided don't generate the deposits JSON file that is \ commonly used for submitting validator deposits via a web UI. \ Using this flag will save several seconds per validator if the \ - user has an alternate strategy for submitting deposits.", + user has an alternate strategy for submitting deposits.\ + If used, the --force-bls-withdrawal-credentials is also required\ + to ensure users are aware that an --eth1-withdrawal-address is not set", ) .action(ArgAction::SetTrue) .help_heading(FLAG_HEADER) From c546304b3d0c0b83a4b5fe3fc67e324cfaf3d60a Mon Sep 17 00:00:00 2001 From: manasnagaraj Date: Wed, 25 Sep 2024 23:59:02 -0400 Subject: [PATCH 2/7] complied docs changes --- book/src/help_bn.md | 4 +--- book/src/help_general.md | 4 +--- book/src/help_vc.md | 4 +--- book/src/help_vm.md | 4 +--- book/src/help_vm_create.md | 8 ++++---- book/src/help_vm_import.md | 4 +--- book/src/help_vm_move.md | 4 +--- validator_manager/src/create_validators.rs | 6 +++--- 8 files changed, 13 insertions(+), 25 deletions(-) diff --git a/book/src/help_bn.md b/book/src/help_bn.md index 733446e5d27..1f7948eddd8 100644 --- a/book/src/help_bn.md +++ b/book/src/help_bn.md @@ -603,6 +603,4 @@ Flags: -z, --zero-ports Sets all listening TCP/UDP ports to 0, allowing the OS to choose some arbitrary free ports. -``` - - +```n \ No newline at end of file diff --git a/book/src/help_general.md b/book/src/help_general.md index 1c2d1266d08..edab4a14dec 100644 --- a/book/src/help_general.md +++ b/book/src/help_general.md @@ -138,6 +138,4 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -``` - - +```n \ No newline at end of file diff --git a/book/src/help_vc.md b/book/src/help_vc.md index 7f2cfab8e3a..509afe1e64c 100644 --- a/book/src/help_vc.md +++ b/book/src/help_vc.md @@ -275,6 +275,4 @@ Flags: If present, the validator client will use longer timeouts for requests made to the beacon node. This flag is generally not recommended, longer timeouts can cause missed duties when fallbacks are used. -``` - - +```n \ No newline at end of file diff --git a/book/src/help_vm.md b/book/src/help_vm.md index f787985b215..cacf888de19 100644 --- a/book/src/help_vm.md +++ b/book/src/help_vm.md @@ -125,6 +125,4 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -``` - - +```n \ No newline at end of file diff --git a/book/src/help_vm_create.md b/book/src/help_vm_create.md index 1803bb534c6..3d0c5a8b2b6 100644 --- a/book/src/help_vm_create.md +++ b/book/src/help_vm_create.md @@ -133,7 +133,9 @@ Flags: When provided don't generate the deposits JSON file that is commonly used for submitting validator deposits via a web UI. Using this flag will save several seconds per validator if the user has an alternate - strategy for submitting deposits. + strategy for submitting deposits. If used, the + --force-bls-withdrawal-credentials is also required to ensure users + are aware that an --eth1-withdrawal-address is not set. --disable-log-timestamp If present, do not include timestamps in logging output. --disable-malloc-tuning @@ -164,6 +166,4 @@ Flags: is safely backed up. --stdin-inputs If present, read all user inputs from stdin instead of tty. -``` - - +```n \ No newline at end of file diff --git a/book/src/help_vm_import.md b/book/src/help_vm_import.md index 0883139ad21..1f99afab85b 100644 --- a/book/src/help_vm_import.md +++ b/book/src/help_vm_import.md @@ -123,6 +123,4 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -``` - - +```n \ No newline at end of file diff --git a/book/src/help_vm_move.md b/book/src/help_vm_move.md index 12dd1e91402..bf870cfc9e4 100644 --- a/book/src/help_vm_move.md +++ b/book/src/help_vm_move.md @@ -142,6 +142,4 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -``` - - +```n \ No newline at end of file diff --git a/validator_manager/src/create_validators.rs b/validator_manager/src/create_validators.rs index abd98e86901..37a6040a9b0 100644 --- a/validator_manager/src/create_validators.rs +++ b/validator_manager/src/create_validators.rs @@ -112,9 +112,9 @@ pub fn cli_app() -> Command { "When provided don't generate the deposits JSON file that is \ commonly used for submitting validator deposits via a web UI. \ Using this flag will save several seconds per validator if the \ - user has an alternate strategy for submitting deposits.\ - If used, the --force-bls-withdrawal-credentials is also required\ - to ensure users are aware that an --eth1-withdrawal-address is not set", + user has an alternate strategy for submitting deposits. \ + If used, the --force-bls-withdrawal-credentials is also required \ + to ensure users are aware that an --eth1-withdrawal-address is not set.", ) .action(ArgAction::SetTrue) .help_heading(FLAG_HEADER) From d4e3e605d06b31e4303382ca96baedca8b103ac1 Mon Sep 17 00:00:00 2001 From: manasnagaraj Date: Thu, 26 Sep 2024 09:45:57 -0400 Subject: [PATCH 3/7] reverted changes and script amended --- book/src/help_bn.md | 3 ++- book/src/help_general.md | 3 ++- book/src/help_vc.md | 3 ++- book/src/help_vm.md | 3 ++- book/src/help_vm_create.md | 3 ++- book/src/help_vm_import.md | 3 ++- book/src/help_vm_move.md | 3 ++- scripts/cli.sh | 3 +-- 8 files changed, 15 insertions(+), 9 deletions(-) diff --git a/book/src/help_bn.md b/book/src/help_bn.md index 1f7948eddd8..f571816c1f4 100644 --- a/book/src/help_bn.md +++ b/book/src/help_bn.md @@ -603,4 +603,5 @@ Flags: -z, --zero-ports Sets all listening TCP/UDP ports to 0, allowing the OS to choose some arbitrary free ports. -```n \ No newline at end of file +``` + diff --git a/book/src/help_general.md b/book/src/help_general.md index edab4a14dec..ef778c66267 100644 --- a/book/src/help_general.md +++ b/book/src/help_general.md @@ -138,4 +138,5 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -```n \ No newline at end of file +``` + diff --git a/book/src/help_vc.md b/book/src/help_vc.md index 509afe1e64c..a77325cd071 100644 --- a/book/src/help_vc.md +++ b/book/src/help_vc.md @@ -275,4 +275,5 @@ Flags: If present, the validator client will use longer timeouts for requests made to the beacon node. This flag is generally not recommended, longer timeouts can cause missed duties when fallbacks are used. -```n \ No newline at end of file +``` + diff --git a/book/src/help_vm.md b/book/src/help_vm.md index cacf888de19..d8a197bf7d9 100644 --- a/book/src/help_vm.md +++ b/book/src/help_vm.md @@ -125,4 +125,5 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -```n \ No newline at end of file +``` + diff --git a/book/src/help_vm_create.md b/book/src/help_vm_create.md index 3d0c5a8b2b6..b4d1de5e997 100644 --- a/book/src/help_vm_create.md +++ b/book/src/help_vm_create.md @@ -166,4 +166,5 @@ Flags: is safely backed up. --stdin-inputs If present, read all user inputs from stdin instead of tty. -```n \ No newline at end of file +``` + diff --git a/book/src/help_vm_import.md b/book/src/help_vm_import.md index 1f99afab85b..10bc0f5b273 100644 --- a/book/src/help_vm_import.md +++ b/book/src/help_vm_import.md @@ -123,4 +123,5 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -```n \ No newline at end of file +``` + diff --git a/book/src/help_vm_move.md b/book/src/help_vm_move.md index bf870cfc9e4..5bbd370b786 100644 --- a/book/src/help_vm_move.md +++ b/book/src/help_vm_move.md @@ -142,4 +142,5 @@ Flags: permissions will be inherited from the parent folder. --stdin-inputs If present, read all user inputs from stdin instead of tty. -```n \ No newline at end of file +``` + diff --git a/scripts/cli.sh b/scripts/cli.sh index 6ca019b39e9..5459e10d127 100755 --- a/scripts/cli.sh +++ b/scripts/cli.sh @@ -15,8 +15,7 @@ write_to_file() { # We need to add the header and the backticks to create the code block. printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file" - # Adjust the width of the help text and append to the end of file - sed -i -e '$a\'$'\n''\n''' "$file" + printf '%s\n' '' '' >> "$file" } CMD=./target/release/lighthouse From 1b6717fd0e996a9ac9baaabc6954c6ff044e21da Mon Sep 17 00:00:00 2001 From: manasnagaraj Date: Thu, 26 Sep 2024 09:47:31 -0400 Subject: [PATCH 4/7] fix --- scripts/cli.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/cli.sh b/scripts/cli.sh index 5459e10d127..e0d24c5a427 100755 --- a/scripts/cli.sh +++ b/scripts/cli.sh @@ -15,7 +15,7 @@ write_to_file() { # We need to add the header and the backticks to create the code block. printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file" - printf '%s\n' '' '' >> "$file" + printf '%s\n\n' '' '' >> "$file" } CMD=./target/release/lighthouse From e50ae0ba512b326a2e701d8f17a3bbed5b0a8a95 Mon Sep 17 00:00:00 2001 From: manasnagaraj Date: Thu, 26 Sep 2024 09:55:48 -0400 Subject: [PATCH 5/7] reverting unwanted changes --- book/src/help_bn.md | 4 +++- book/src/help_general.md | 4 +++- book/src/help_vc.md | 4 +++- book/src/help_vm.md | 4 +++- book/src/help_vm_create.md | 4 +++- book/src/help_vm_import.md | 4 +++- book/src/help_vm_move.md | 4 +++- scripts/cli.sh | 1 + 8 files changed, 22 insertions(+), 7 deletions(-) diff --git a/book/src/help_bn.md b/book/src/help_bn.md index f571816c1f4..f453253180c 100644 --- a/book/src/help_bn.md +++ b/book/src/help_bn.md @@ -604,4 +604,6 @@ Flags: Sets all listening TCP/UDP ports to 0, allowing the OS to choose some arbitrary free ports. ``` - + + + diff --git a/book/src/help_general.md b/book/src/help_general.md index ef778c66267..775512ea6d1 100644 --- a/book/src/help_general.md +++ b/book/src/help_general.md @@ -139,4 +139,6 @@ Flags: --stdin-inputs If present, read all user inputs from stdin instead of tty. ``` - + + + diff --git a/book/src/help_vc.md b/book/src/help_vc.md index a77325cd071..6239185416c 100644 --- a/book/src/help_vc.md +++ b/book/src/help_vc.md @@ -276,4 +276,6 @@ Flags: made to the beacon node. This flag is generally not recommended, longer timeouts can cause missed duties when fallbacks are used. ``` - + + + diff --git a/book/src/help_vm.md b/book/src/help_vm.md index d8a197bf7d9..65f30d63edc 100644 --- a/book/src/help_vm.md +++ b/book/src/help_vm.md @@ -126,4 +126,6 @@ Flags: --stdin-inputs If present, read all user inputs from stdin instead of tty. ``` - + + + diff --git a/book/src/help_vm_create.md b/book/src/help_vm_create.md index b4d1de5e997..a1fd4785292 100644 --- a/book/src/help_vm_create.md +++ b/book/src/help_vm_create.md @@ -167,4 +167,6 @@ Flags: --stdin-inputs If present, read all user inputs from stdin instead of tty. ``` - + + + diff --git a/book/src/help_vm_import.md b/book/src/help_vm_import.md index 10bc0f5b273..c473f50a8ee 100644 --- a/book/src/help_vm_import.md +++ b/book/src/help_vm_import.md @@ -124,4 +124,6 @@ Flags: --stdin-inputs If present, read all user inputs from stdin instead of tty. ``` - + + + diff --git a/book/src/help_vm_move.md b/book/src/help_vm_move.md index 5bbd370b786..e387fb96bd3 100644 --- a/book/src/help_vm_move.md +++ b/book/src/help_vm_move.md @@ -143,4 +143,6 @@ Flags: --stdin-inputs If present, read all user inputs from stdin instead of tty. ``` - + + + diff --git a/scripts/cli.sh b/scripts/cli.sh index e0d24c5a427..db98b5520e9 100755 --- a/scripts/cli.sh +++ b/scripts/cli.sh @@ -15,6 +15,7 @@ write_to_file() { # We need to add the header and the backticks to create the code block. printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file" + # Adjust the width of the help text and append to the end of file printf '%s\n\n' '' '' >> "$file" } From 57214cb682bb5946408fa23182aeed6468b395a1 Mon Sep 17 00:00:00 2001 From: manasnagaraj Date: Thu, 26 Sep 2024 23:15:35 -0400 Subject: [PATCH 6/7] making linter happy --- book/src/help_bn.md | 1 - book/src/help_general.md | 1 - book/src/help_vc.md | 1 - book/src/help_vm.md | 1 - book/src/help_vm_create.md | 1 - book/src/help_vm_import.md | 1 - book/src/help_vm_move.md | 1 - scripts/cli.sh | 2 +- 8 files changed, 1 insertion(+), 8 deletions(-) diff --git a/book/src/help_bn.md b/book/src/help_bn.md index f453253180c..733446e5d27 100644 --- a/book/src/help_bn.md +++ b/book/src/help_bn.md @@ -606,4 +606,3 @@ Flags: ``` - diff --git a/book/src/help_general.md b/book/src/help_general.md index 775512ea6d1..1c2d1266d08 100644 --- a/book/src/help_general.md +++ b/book/src/help_general.md @@ -141,4 +141,3 @@ Flags: ``` - diff --git a/book/src/help_vc.md b/book/src/help_vc.md index 6239185416c..7f2cfab8e3a 100644 --- a/book/src/help_vc.md +++ b/book/src/help_vc.md @@ -278,4 +278,3 @@ Flags: ``` - diff --git a/book/src/help_vm.md b/book/src/help_vm.md index 65f30d63edc..f787985b215 100644 --- a/book/src/help_vm.md +++ b/book/src/help_vm.md @@ -128,4 +128,3 @@ Flags: ``` - diff --git a/book/src/help_vm_create.md b/book/src/help_vm_create.md index a1fd4785292..cde822e8946 100644 --- a/book/src/help_vm_create.md +++ b/book/src/help_vm_create.md @@ -169,4 +169,3 @@ Flags: ``` - diff --git a/book/src/help_vm_import.md b/book/src/help_vm_import.md index c473f50a8ee..0883139ad21 100644 --- a/book/src/help_vm_import.md +++ b/book/src/help_vm_import.md @@ -126,4 +126,3 @@ Flags: ``` - diff --git a/book/src/help_vm_move.md b/book/src/help_vm_move.md index e387fb96bd3..12dd1e91402 100644 --- a/book/src/help_vm_move.md +++ b/book/src/help_vm_move.md @@ -145,4 +145,3 @@ Flags: ``` - diff --git a/scripts/cli.sh b/scripts/cli.sh index db98b5520e9..962ecb8d341 100755 --- a/scripts/cli.sh +++ b/scripts/cli.sh @@ -16,7 +16,7 @@ write_to_file() { printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file" # Adjust the width of the help text and append to the end of file - printf '%s\n\n' '' '' >> "$file" + printf '%s\n' '' '' >> "$file" } CMD=./target/release/lighthouse From b653499abd04e1e006481d343099dc421aab9c0f Mon Sep 17 00:00:00 2001 From: manasnagaraj Date: Thu, 26 Sep 2024 23:22:56 -0400 Subject: [PATCH 7/7] requested changes --- scripts/cli.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/cli.sh b/scripts/cli.sh index 962ecb8d341..e43c05a834f 100755 --- a/scripts/cli.sh +++ b/scripts/cli.sh @@ -16,7 +16,7 @@ write_to_file() { printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file" # Adjust the width of the help text and append to the end of file - printf '%s\n' '' '' >> "$file" + printf "\n\n%s\n" "" >> "$file" } CMD=./target/release/lighthouse