From dca18d9a10f566197ea6a935d6334739e1d1d52a Mon Sep 17 00:00:00 2001 From: Jonathan Shook Date: Tue, 11 Aug 2020 18:02:22 -0500 Subject: [PATCH] mark fenced code sections with type --- driver-cql-shaded/src/main/resources/cql.md | 21 +++++++++----------- driver-mongodb/src/main/resources/mongodb.md | 7 +++---- driver-stdout/src/main/resources/stdout.md | 15 ++++++-------- driver-tcp/src/main/resources/tcpclient.md | 7 +++---- driver-tcp/src/main/resources/tcpserver.md | 10 +++++----- 5 files changed, 26 insertions(+), 34 deletions(-) diff --git a/driver-cql-shaded/src/main/resources/cql.md b/driver-cql-shaded/src/main/resources/cql.md index 8c4591816..edaaaaa2f 100644 --- a/driver-cql-shaded/src/main/resources/cql.md +++ b/driver-cql-shaded/src/main/resources/cql.md @@ -6,24 +6,21 @@ detailed metrics provided for both. ### Example activity definitions Run a cql activity named 'cql1', with definitions from activities/cqldefs.yaml -~~~ -... driver=cql alias=cql1 workload=cqldefs -~~~ + + ... driver=cql alias=cql1 workload=cqldefs Run a cql activity defined by cqldefs.yaml, but with shortcut naming -~~~ -... driver=cql workload=cqldefs -~~~ + + ... driver=cql workload=cqldefs Only run statement groups which match a tag regex -~~~ -... driver=cql workload=cqldefs tags=group:'ddl.*' -~~~ + + ... driver=cql workload=cqldefs tags=group:'ddl.*' Run the matching 'dml' statements, with 100 cycles, from [1000..1100) -~~~ -... driver=cql workload=cqldefs tags=group:'dml.*' cycles=1000..1100 -~~~ + + ... driver=cql workload=cqldefs tags=group:'dml.*' cycles=1000..1100 + This last example shows that the cycle range is [inclusive..exclusive), to allow for stacking test intervals. This is standard across all activity types. diff --git a/driver-mongodb/src/main/resources/mongodb.md b/driver-mongodb/src/main/resources/mongodb.md index ff31d49dc..bae8d5f3a 100644 --- a/driver-mongodb/src/main/resources/mongodb.md +++ b/driver-mongodb/src/main/resources/mongodb.md @@ -1,13 +1,12 @@ # MongoDB Driver -This is a driver for MongoDB. It supports the `db.runCommand` API described in [here](https://docs.mongodb.com/manual/reference/command/). +This is a driver for MongoDB. It supports the `db.runCommand` API described in [here](https://docs.mongodb.com/manual/reference/command/). ### Example activity definitions Run a mongodb activity with definitions from activities/mongodb-basic.yaml -``` -... driver=mongodb yaml=activities/mongo-basic.yaml -``` + + ... driver=mongodb yaml=activities/mongo-basic.yaml ### MongoDB ActivityType Parameters diff --git a/driver-stdout/src/main/resources/stdout.md b/driver-stdout/src/main/resources/stdout.md index 52c6ccf1c..9feb8f43f 100644 --- a/driver-stdout/src/main/resources/stdout.md +++ b/driver-stdout/src/main/resources/stdout.md @@ -8,19 +8,16 @@ that uses the curly brace token form in statements. ## Example activity definitions Run a stdout activity named 'stdout-test', with definitions from activities/stdout-test.yaml -~~~ -... driver=stdout workload=stdout-test -~~~ + + ... driver=stdout workload=stdout-test Only run statement groups which match a tag regex -~~~ -... driver=stdout workload=stdout-test tags=group:'ddl.*' -~~~ + + ... driver=stdout workload=stdout-test tags=group:'ddl.*' Run the matching 'dml' statements, with 100 cycles, from [1000..1100) -~~~ -... driver=stdout workload=stdout-test tags=group:'dml.*' cycles=1000..11000 filename=test.csv -~~~ + + ... driver=stdout workload=stdout-test tags=group:'dml.*' cycles=1000..11000 filename=test.csv This last example shows that the cycle range is [inclusive..exclusive), to allow for stacking test intervals. This is standard across all diff --git a/driver-tcp/src/main/resources/tcpclient.md b/driver-tcp/src/main/resources/tcpclient.md index 82ca1f4c6..499cfee68 100644 --- a/driver-tcp/src/main/resources/tcpclient.md +++ b/driver-tcp/src/main/resources/tcpclient.md @@ -19,9 +19,8 @@ a very high value. In this case, the tries metric will still give you some measu ## Examples Run a stdout activity named 'stdout-test', with definitions from activities/stdout-test.yaml -~~~ -... driver=tcpserver yaml=stdout-test -~~~ + + ... driver=tcpserver yaml=stdout-test ## Driver Parameters @@ -41,7 +40,7 @@ Run a stdout activity named 'stdout-test', with definitions from activities/stdo To enable, specifies the type of the SSL implementation with either `jdk` or `openssl`. [Additional parameters may need to be provided](../../../../driver-cql/src/main/resources/ssl.md). - + - **host** - this is the name to connect to (remote server IP address) - default: localhost - dynamic: false diff --git a/driver-tcp/src/main/resources/tcpserver.md b/driver-tcp/src/main/resources/tcpserver.md index f3f679bd2..9122e002d 100644 --- a/driver-tcp/src/main/resources/tcpserver.md +++ b/driver-tcp/src/main/resources/tcpserver.md @@ -21,9 +21,9 @@ saturation. ## Examples Run a stdout activity named 'stdout-test', with definitions from activities/stdout-test.yaml -~~~ -... driver=tcpserver yaml=stdout-test -~~~ + + + ... driver=tcpserver yaml=stdout-test ## Driver Parameters @@ -40,11 +40,11 @@ Run a stdout activity named 'stdout-test', with definitions from activities/stdo - **ssl** - boolean to enable or disable ssl - default: false - dynamic: false - + To enable, specifies the type of the SSL implementation with either `jdk` or `openssl`. [Additional parameters may need to be provided](../../../../driver-cql/src/main/resources/ssl.md). - + - **host** - this is the name to bind to (local interface address) - default: localhost - dynamic: false