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

Doc: add packageFile argument in peer lifecycle chaincode install help command #5011

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jmmunoz-kolokium
Copy link

Type of change

  • Documentation update

Description

Add packageFile argument in peer lifecycle chaincode install help command.

Additional details

Fix help information "peer lifecycle chaincode install [flags]" with "peer lifecycle chaincode install [packageFiles] [flags]"

Tested by building the peer binary:

$ cd fabric
$ make peer
Building build/bin/peer...
$./build/bin/peer lifecycle chaincode install --help
Install a chaincode on a peer.

Usage:
  peer lifecycle chaincode install [packageFiles] [flags]

Flags:
      --connectionProfile string       The fully qualified path to the connection profile that provides the necessary connection information for the network. Note: currently only supported for providing peer connection information
  -h, --help                           help for install
      --peerAddresses stringArray      The addresses of the peers to connect to
      --targetPeer string              When using a connection profile, the name of the peer to target for this action
      --tlsRootCertFiles stringArray   If TLS is enabled, the paths to the TLS root cert files of the peers to connect to. The order and number of certs specified should match the --peerAddresses flag

Global Flags:
      --cafile string                       Path to file containing PEM-encoded trusted certificate(s) for the ordering endpoint
      --certfile string                     Path to file containing PEM-encoded X509 public key to use for mutual TLS communication with the orderer endpoint
      --clientauth                          Use mutual TLS when communicating with the orderer endpoint
      --connTimeout duration                Timeout for client to connect (default 3s)
      --keyfile string                      Path to file containing PEM-encoded private key to use for mutual TLS communication with the orderer endpoint
  -o, --orderer string                      Ordering service endpoint
      --ordererTLSHostnameOverride string   The hostname override to use when validating the TLS connection to the orderer
      --tls                                 Use TLS when communicating with the orderer endpoint
      --tlsHandshakeTimeShift duration      The amount of time to shift backwards for certificate expiration checks during TLS handshakes with the orderer endpoint

Related issues

Missing argument in help information for command "peer lifecycle chaincode install

Copy link
Contributor

@satota2 satota2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmmunoz-kolokium
Thank you for the update, and I apologize for missing this in the previous review.

Since packageFiles refers to a single file, I believe it would be more consistent with other sub commands to use the singular form, packageFile. Would it be possible for you to make this adjustment?

If you could modify fabric/internal/peer/lifecycle/chaincode/install.go file locally, then run make peer and make help-docs, and afterwards, force push the PR, that would be great. Thank you!

docs/source/commands/peerlifecycle.md Outdated Show resolved Hide resolved
internal/peer/lifecycle/chaincode/install.go Outdated Show resolved Hide resolved
@jmmunoz-kolokium jmmunoz-kolokium force-pushed the jmmunoz-kolokiumupdate-peer-command-help branch from 96455be to 1b7d015 Compare October 7, 2024 12:00
Signed-off-by: Juanma Muñoz <jmmunoz@kolokium.com>

Add packageFiles argument when presenting "peer lifecycle chaincode
install" help information

Resolves hyperledger#4976
@jmmunoz-kolokium jmmunoz-kolokium force-pushed the jmmunoz-kolokiumupdate-peer-command-help branch from 1b7d015 to 4124acb Compare October 7, 2024 12:08
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.

2 participants