[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]>
hyperledger · Feb 25, 2017 · 2df8355 · 2df8355
1 parent 5b3edfc
commit 2df8355
Showing 1 changed file with 27 additions and 26 deletions.
diff --git a/common/configtx/tool/configtx.yaml b/common/configtx/tool/configtx.yaml
@@ -4,14 +4,14 @@
 #   Profile
 #
 #   - Different configuration profiles may be encoded here to be specified
-#   as parameters to the configtxgen tool
+#   as parameters to the configtxgen tool.
 #
 ################################################################################
 Profiles:
 
     # SampleInsecureSolo defines a configuration which uses the Solo orderer,
     # contains no MSP definitions, and allows all transactions and channel
-    # creation requests
+    # creation requests.
     SampleInsecureSolo:
         Orderer:
             <<: *OrdererDefaults
@@ -49,35 +49,35 @@ Profiles:
 ################################################################################
 Organizations:
 
-    # SampleOrg defines an MSP using the sampleconfig.  It should never be used
-    # in production but may be used as a template for other definitions
+    # SampleOrg defines an MSP using the sampleconfig. It should never be used
+    # in production but may be used as a template for other definitions.
     - &SampleOrg
         # DefaultOrg defines the organization which is used in the sampleconfig
-        # of the fabric.git development environment
+        # of the fabric.git development environment.
         Name: SampleOrg
 
-        # ID to load the MSP definition as
+        # ID to load the MSP definition as.
         ID: DEFAULT
 
-        # MSPDir is the filesystem path which contains the MSP configuration
+        # MSPDir is the filesystem path which contains the MSP configuration.
         MSPDir: msp/sampleconfig
 
-        # BCCSP (Blockchain crypto provider): Select which crypto implementation or
-        # library to use
+        # BCCSP: Select which crypto implementation or library to use for the
+        # blockchain crypto service provider.
         BCCSP:
             Default: SW
             SW:
                 Hash: SHA3
                 Security: 256
-                # Location of Key Store. If this is unset, a location will 
-                # be chosen using 'MSPDir'/keystore
-                FileKeyStore: 
-                    KeyStore: 
-                
+                # Location of key store. If this is unset, a location will
+                # be chosen using: 'MSPDir'/keystore
+                FileKeyStore:
+                    KeyStore:
+
         AnchorPeers:
             # AnchorPeers defines the location of peers which can be used
-            # for cross org gossip communication.  Note, this value is only
-            # encoded in the genesis block in the Application section context
+            # for cross org gossip communication. Note, this value is only
+            # encoded in the genesis block in the Application section context.
             - Host: 127.0.0.1
               Port: 7051
 
@@ -86,25 +86,26 @@ Organizations:
 #   SECTION: Orderer
 #
 #   - This section defines the values to encode into a config transaction or
-#   genesis block for orderer related parameters
+#   genesis block for orderer related parameters.
 #
 ################################################################################
 Orderer: &OrdererDefaults
 
-    # Orderer Type: The orderer implementation to start
-    # Available types are "solo" and "kafka"
+    # Orderer Type: The orderer implementation to start.
+    # Available types are "solo" and "kafka".
     OrdererType: solo
 
     Addresses:
         - 127.0.0.1:7050
 
-    # Batch Timeout: The amount of time to wait before creating a batch
+    # Batch Timeout: The amount of time to wait before creating a batch.
     BatchTimeout: 10s
 
-    # Batch Size: Controls the number of messages batched into a block
+    # Batch Size: Controls the number of messages batched into a block.
     BatchSize:
 
-        # Max Message Count: The maximum number of messages to permit in a batch
+        # Max Message Count: The maximum number of messages to permit in a
+        # batch.
         MaxMessageCount: 10
 
         # Absolute Max Bytes: The absolute maximum number of bytes allowed for
@@ -118,25 +119,25 @@ Orderer: &OrdererDefaults
         PreferredMaxBytes: 512 KB
 
     Kafka:
-        # Brokers: A list of Kafka brokers to which the orderer connects
+        # Brokers: A list of Kafka brokers to which the orderer connects.
         # NOTE: Use IP:port notation
         Brokers:
             - 127.0.0.1:9092
 
     # Organizations is the list of orgs which are defined as participants on
-    # the orderer side of the network
+    # the orderer side of the network.
     Organizations:
 
 ################################################################################
 #
 #   SECTION: Application
 #
 #   - This section defines the values to encode into a config transaction or
-#   genesis block for application related parameters
+#   genesis block for application related parameters.
 #
 ################################################################################
 Application: &ApplicationDefaults
 
     # Organizations is the list of orgs which are defined as participants on
-    # the application side of the network
+    # the application side of the network.
     Organizations: