Fix doc gen error

Fix doc gen error by escaping the invalid characters. Signed-off-by: David Enyeart <[email protected]>
hyperledger · Aug 29, 2023 · 63ea130 · 63ea130
1 parent 2e58a15
commit 63ea130
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/docs/source/servercli.rst b/docs/source/servercli.rst
@@ -5,17 +5,17 @@ Fabric-CA Server's CLI
 ::
 
     Hyperledger Fabric Certificate Authority Server
-    
+
     Usage:
       fabric-ca-server [command]
-    
+
     Available Commands:
       completion  Generate the autocompletion script for the specified shell
       help        Help about any command
       init        Initialize the fabric-ca server
       start       Start the fabric-ca server
       version     Prints Fabric CA Server version
-    
+
     Flags:
           --address string                            Listening address of fabric-ca-server (default "0.0.0.0")
       -b, --boot string                               The user:pass for bootstrap admin which is required to build default config file
@@ -39,6 +39,7 @@ Fabric-CA Server's CLI
           --csr.keyrequest.reusekey                   Reuse existing key during reenrollment
           --csr.keyrequest.size int                   Specify key size
           --csr.serialnumber string                   The serial number in a certificate signing request to a parent fabric-ca-server
+      -d, --debug bool                                Enable debug level logging (slows server) (default false)    
           --db.datasource string                      Data source which is database specific (default "fabric-ca-server.db")
           --db.tls.certfiles strings                  A list of comma-separated PEM-encoded trusted certificate files (e.g. root1.pem,root2.pem)
           --db.tls.client.certfile string             PEM-encoded certificate file when mutual authenticate is enabled
@@ -74,5 +75,5 @@ Fabric-CA Server's CLI
           --tls.clientauth.type string                Policy the server will follow for TLS Client Authentication. (default "noclientcert")
           --tls.enabled                               Enable TLS on the listening port
           --tls.keyfile string                        PEM-encoded TLS key for server's listening port
-    
+
     Use "fabric-ca-server [command] --help" for more information about a command.
diff --git a/lib/serverconfig.go b/lib/serverconfig.go
@@ -34,7 +34,7 @@ type ServerConfig struct {
 	// Cross-Origin Resource Sharing settings for the server
 	CORS CORS
 	// Enables debug logging
-	Debug bool `def:"false" opt:"d" help:"Enable debug level logging" hide:"true"`
+	Debug bool `def:"false" opt:"d" help:"Enable debug level logging (slows server)"`
 	// Sets the logging level on the server
 	LogLevel string `help:"Set logging level (info, warning, debug, error, fatal, critical)"`
 	// TLS for the server's listening endpoint

diff --git a/scripts/regenDocs b/scripts/regenDocs
@@ -215,6 +215,6 @@ echo "Doc generation completed"
 # Only checking status under docs/source folder
 cd $docsdir
 if [[ $(git status . --porcelain --untracked-file=no) ]]; then
-    echo "ERROR: New rst documentation files generated that don't match the existing docs, run `make docs` to re-generate the rst documentation files before pushing"
+    echo "ERROR: New rst documentation files generated that don't match the existing docs, run \`make docs\` to re-generate the rst documentation files before pushing"
     exit 1
 fi