Skip to content

Commit 2df8355

Browse files
committed
[FAB-2483] Improve configtx.yaml formatting & text
https://jira.hyperledger.org/browse/FAB-2483 Break lines at 80 characters as the ### lines suggest, properly explain the acronyms, convert double spaces to single spaces because we no longer use typewriters, add periods to every sentence to keep things consistent, etc. The companion to: https://jira.hyperledger.org/browse/FAB-2480 Change-Id: Ic2e987e1dd3fe5dd2378175acef40aa0862c10ae Signed-off-by: Kostas Christidis <[email protected]>
1 parent 5b3edfc commit 2df8355

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

common/configtx/tool/configtx.yaml

+27-26
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
# Profile
55
#
66
# - Different configuration profiles may be encoded here to be specified
7-
# as parameters to the configtxgen tool
7+
# as parameters to the configtxgen tool.
88
#
99
################################################################################
1010
Profiles:
1111

1212
# SampleInsecureSolo defines a configuration which uses the Solo orderer,
1313
# contains no MSP definitions, and allows all transactions and channel
14-
# creation requests
14+
# creation requests.
1515
SampleInsecureSolo:
1616
Orderer:
1717
<<: *OrdererDefaults
@@ -49,35 +49,35 @@ Profiles:
4949
################################################################################
5050
Organizations:
5151

52-
# SampleOrg defines an MSP using the sampleconfig. It should never be used
53-
# in production but may be used as a template for other definitions
52+
# SampleOrg defines an MSP using the sampleconfig. It should never be used
53+
# in production but may be used as a template for other definitions.
5454
- &SampleOrg
5555
# DefaultOrg defines the organization which is used in the sampleconfig
56-
# of the fabric.git development environment
56+
# of the fabric.git development environment.
5757
Name: SampleOrg
5858

59-
# ID to load the MSP definition as
59+
# ID to load the MSP definition as.
6060
ID: DEFAULT
6161

62-
# MSPDir is the filesystem path which contains the MSP configuration
62+
# MSPDir is the filesystem path which contains the MSP configuration.
6363
MSPDir: msp/sampleconfig
6464

65-
# BCCSP (Blockchain crypto provider): Select which crypto implementation or
66-
# library to use
65+
# BCCSP: Select which crypto implementation or library to use for the
66+
# blockchain crypto service provider.
6767
BCCSP:
6868
Default: SW
6969
SW:
7070
Hash: SHA3
7171
Security: 256
72-
# Location of Key Store. If this is unset, a location will
73-
# be chosen using 'MSPDir'/keystore
74-
FileKeyStore:
75-
KeyStore:
76-
72+
# Location of key store. If this is unset, a location will
73+
# be chosen using: 'MSPDir'/keystore
74+
FileKeyStore:
75+
KeyStore:
76+
7777
AnchorPeers:
7878
# AnchorPeers defines the location of peers which can be used
79-
# for cross org gossip communication. Note, this value is only
80-
# encoded in the genesis block in the Application section context
79+
# for cross org gossip communication. Note, this value is only
80+
# encoded in the genesis block in the Application section context.
8181
- Host: 127.0.0.1
8282
Port: 7051
8383

@@ -86,25 +86,26 @@ Organizations:
8686
# SECTION: Orderer
8787
#
8888
# - This section defines the values to encode into a config transaction or
89-
# genesis block for orderer related parameters
89+
# genesis block for orderer related parameters.
9090
#
9191
################################################################################
9292
Orderer: &OrdererDefaults
9393

94-
# Orderer Type: The orderer implementation to start
95-
# Available types are "solo" and "kafka"
94+
# Orderer Type: The orderer implementation to start.
95+
# Available types are "solo" and "kafka".
9696
OrdererType: solo
9797

9898
Addresses:
9999
- 127.0.0.1:7050
100100

101-
# Batch Timeout: The amount of time to wait before creating a batch
101+
# Batch Timeout: The amount of time to wait before creating a batch.
102102
BatchTimeout: 10s
103103

104-
# Batch Size: Controls the number of messages batched into a block
104+
# Batch Size: Controls the number of messages batched into a block.
105105
BatchSize:
106106

107-
# Max Message Count: The maximum number of messages to permit in a batch
107+
# Max Message Count: The maximum number of messages to permit in a
108+
# batch.
108109
MaxMessageCount: 10
109110

110111
# Absolute Max Bytes: The absolute maximum number of bytes allowed for
@@ -118,25 +119,25 @@ Orderer: &OrdererDefaults
118119
PreferredMaxBytes: 512 KB
119120

120121
Kafka:
121-
# Brokers: A list of Kafka brokers to which the orderer connects
122+
# Brokers: A list of Kafka brokers to which the orderer connects.
122123
# NOTE: Use IP:port notation
123124
Brokers:
124125
- 127.0.0.1:9092
125126

126127
# Organizations is the list of orgs which are defined as participants on
127-
# the orderer side of the network
128+
# the orderer side of the network.
128129
Organizations:
129130

130131
################################################################################
131132
#
132133
# SECTION: Application
133134
#
134135
# - This section defines the values to encode into a config transaction or
135-
# genesis block for application related parameters
136+
# genesis block for application related parameters.
136137
#
137138
################################################################################
138139
Application: &ApplicationDefaults
139140

140141
# Organizations is the list of orgs which are defined as participants on
141-
# the application side of the network
142+
# the application side of the network.
142143
Organizations:

0 commit comments

Comments
 (0)