diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b17227132..cf9cae572 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,13 +18,14 @@ Some quick how-to docs have been written for some of the subject-matter areas in NoSQLBench. If you need an onramp that is not listed, here let us know! -[I am a developer and I want to contribute a driver.](devdocs/contributing_drivers.md) +[I am a developer and I want to contribute a driver.] +(devdocs/devguide/drivers/README.md) -[I am a user and I want to improve the documentation.](devdocs/improving_documentation.md) +[I am a user and I want to improve the documentation.](devdocs/devguide/nb_docs.md) -[I am a user and I want to contribute built-in scenarios.](devdocs/contributing_builtins.md) +[I am a user and I want to contribute built-in scenarios.](devdocs/devguide/adding_scenarios.md) -[I am a UI developer and I want to improve the NoSQLBench UI (NBUI)](devdocs/developint_nbui.md) +[I am a UI developer and I want to improve the NoSQLBench UI (NBUI)](devdocs/devguide/nbui/README.md) ## Contribution Ideas diff --git a/engine-docs/src/main/resources/docs-for-ebhistoric/nb-cli-docs/cycle_log.md b/devdocs/docs-for-ebhistoric/nb-cli-docs/cycle_log.md similarity index 56% rename from engine-docs/src/main/resources/docs-for-ebhistoric/nb-cli-docs/cycle_log.md rename to devdocs/docs-for-ebhistoric/nb-cli-docs/cycle_log.md index ea4481cd1..7440ef5c9 100644 --- a/engine-docs/src/main/resources/docs-for-ebhistoric/nb-cli-docs/cycle_log.md +++ b/devdocs/docs-for-ebhistoric/nb-cli-docs/cycle_log.md @@ -2,40 +2,43 @@ ### cycle_log format -This file is a binary format that encodes ranges of cycles -in RLE interval form. This means that it will be relatively compact -for scenarios that have many repeats of the same result, as well -as low-overhead when running scenarios. +This file is a binary format that encodes ranges of cycles in RLE interval +form. This means that it will be relatively compact for scenarios that +have many repeats of the same result, as well as low-overhead when running +scenarios. All cycle logfiles have the *.cyclelog* suffix. ### export cycle_log to text format -You can dump an rlefile to the screen to see the content in text form -by running a command like this: +You can dump an rlefile to the screen to see the content in text form by +running a command like this: PROG --export-cycle-log [spans|cycles] You do not need to specify the extension. If you do not specify either -optional format at the end, then *spans* is assumed. It will print output like this: +optional format at the end, then *spans* is assumed. It will print output +like this: 0->3 1->3 ... -Alternately, you can see the individual RLE spans with the *spans* format, which looks -like this: +Alternately, you can see the individual RLE spans with the *spans* format, +which looks like this: [0,100)->3 ... -This format uses the '[x,y)' notation to remind you that the spans are all closed-open -intervals, including the starting cycle number but not the ending one. +This format uses the '[x,y)' notation to remind you that the spans are all +closed-open intervals, including the starting cycle number but not the +ending one. ### importing text format to a cycle_log -If you need to modify and then re-use a cycle log, you can do this with simple text tools. -Once you have modified the file, you can import it back to the native format with: +If you need to modify and then re-use a cycle log, you can do this with +simple text tools. Once you have modified the file, you can import it back +to the native format with: PROG --import-cycle-log @@ -43,22 +46,25 @@ The importer recognizes both formats listed above. ### Using cycle logs as outputs -When you want an activity to record its per-cycle result for -later use, you can specify a cycle log as its output. This is configured as: +When you want an activity to record its per-cycle result for later use, +you can specify a cycle log as its output. This is configured as: ... output=type:cyclelog,file:somefile ... -If you do not specify the file parameter, then the alias of the activity is used. +If you do not specify the file parameter, then the alias of the activity +is used. ### Using cycle logs as inputs -You can have all the cycles in a cycle log as the input cycles of an activity like this: +You can have all the cycles in a cycle log as the input cycles of an +activity like this: ... input=type:cyclelog,file:somefile ... -Note, that when you use cycle logs as inputs, not all cycles are guaranteed to be -in order. In most cases, they will be, due to reordering support on RLE encoding. However, -that uses a sliding-window buffer, and in some cases RLE spans can occur out of -order in a cycle log. +Note, that when you use cycle logs as inputs, not all cycles are +guaranteed to be in order. In most cases, they will be, due to reordering +support on RLE encoding. However, that uses a sliding-window buffer, and +in some cases RLE spans can occur out of order in a cycle log. -If you do not specify the fie parameter, then the alias of the activity is used. +If you do not specify the fie parameter, then the alias of the activity is +used. diff --git a/engine-cli/src/main/resources/error-handlers.md b/engine-cli/src/main/resources/error-handlers.md index ec2fc12d0..441a05173 100644 --- a/engine-cli/src/main/resources/error-handlers.md +++ b/engine-cli/src/main/resources/error-handlers.md @@ -61,6 +61,10 @@ matching any of the error patterns against the exception name, that column (the handler list) is selected, and each handler in that list is applied in order to the error. +Specifically, the Java class name of the exception type is matched against +the error patterns going left to right. The first one that matches selects +the error handler list to use. + ## Error Handler Configuration The default setting of `errors=stop` uses a shorthand form for specifying