[ARTEMIS-3486] refresh data tools documentation

• Type: Task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.18.0
• Fix Version/s: 2.19.0

Environment

Mac OS 10.15.7

• Assignee: Robbie Gemmell
• Reporter: Sebastian-Ion TINCU
• Created: 16/Sep/21 13:49
• Updated: 16/Sep/21 22:23
• Resolved: 16/Sep/21 22:23

Description

The CLI data tools documentation doesnt notice it is discussing the broker-instance related commands. The examples output and options shown are also stale and missing many recent additions, it should be updated.

 

 

====== Original Description =====

Steps to reproduce:

1. Download the latest apache artemis binary and unarchive
2. Run

   ./bin/artemis data exp
   

Expected results, according to https://activemq.apache.org/components/artemis/documentation/latest/data-tools.html :

1. the exp subcommand should be known

Actual results:

1. the command fails with

   Found unexpected parameters: [exp]
   

Running

./bin/artemis help data

outputs

NAME
        artemis data - data tools group (print) (example ./artemis data print)

SYNOPSIS
        artemis data
        artemis data print ...
        artemis data recover ...

COMMANDS
...

Issue Links

• links to: GitHub Pull Request #3756