Skip to content

cephfs-journal-tool: disambiguate usage of all keyword (in tool help).#52149

Merged
vshankar merged 1 commit intoceph:mainfrom
manishym:journal-tool-help-fix
Jun 26, 2023
Merged

cephfs-journal-tool: disambiguate usage of all keyword (in tool help).#52149
vshankar merged 1 commit intoceph:mainfrom
manishym:journal-tool-help-fix

Conversation

@manishym
Copy link
Collaborator

@manishym manishym commented Jun 22, 2023

   The fs:all for rank option description was confusing. It seemd like the fs was optional, but it is mandatory. This change modifies the help message to reflect the correct way to use all in the --rank option.

Now

→ ./bin/cephfs-journal-tool -h                                                                                                                                                                                                                                                                                                                                                         
Usage:                                                                                                                                                                                                                                                                                                                                                                                 
  cephfs-journal-tool [options] journal <command>                                                                                                                                                                                                                                                                                                                                      
    <command>:                                                                                                                                                                                                                                                                                                                                                                         
      inspect                                                                                                                                                                                                                                                                                                                                                                          
      import <path> [--force]                                                                                                                                                                                                                                                                                                                                                          
      export <path>                                                                                                                                                                                                                                                                                                                                                                    
      reset [--force]                                                                                                                                                                                                                                                                                                                                                                  
  cephfs-journal-tool [options] header <get|set> <field> <value>
    <field>: [trimmed_pos|expire_pos|write_pos|pool_id]
  cephfs-journal-tool [options] event <effect> <selector> <output> [special options]
    <selector>:
      --range=<start>..<end>
      --path=<substring>
      --inode=<integer>
      --type=<UPDATE|OPEN|SESSION...><
      --frag=<ino>.<frag> [--dname=<dentry string>]
      --client=<session id integer>
    <effect>: [get|recover_dentries|splice]
    <output>: [summary|list|binary|json] [--path <path>]

General options:
  --rank=filesystem:{mds-rank|all} Journal rank or all (mandatory)
  --journal=<mdlog|purge_queue>  Journal type (purge_queue means
                                 this journal is used to queue for purge operation,
                                 default is mdlog, and only mdlog support event mode)

Special options
  --alternate-pool <name>     Alternative metadata pool to target
                              when using recover_dentries.
  --conf/-c FILE    read configuration from the given configuration file
  --id ID           set ID portion of my name
  --name/-n TYPE.ID set name
  --cluster NAME    set cluster name (default: ceph)
  --setuser USER    set uid to user or uid (and gid to user's gid)
  --setgroup GROUP  set gid to group or gid
  --version         show version and quit

Contribution Guidelines

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

@github-actions github-actions bot added the cephfs Ceph File System label Jun 22, 2023
@manishym manishym force-pushed the journal-tool-help-fix branch 2 times, most recently from 6e97d84 to 8a33b28 Compare June 22, 2023 03:20
@vshankar vshankar requested a review from a team June 22, 2023 03:53
@vshankar
Copy link
Contributor

@manishym minor nit in pr/commit title: disambiguate usage of all keyword (in tool help).

@manishym manishym force-pushed the journal-tool-help-fix branch from 8a33b28 to 602ce98 Compare June 25, 2023 11:58
@manishym manishym changed the title cephfs-journal-tool: Better help message. cephfs-journal-tool: disambiguate usage of all keyword (in tool help). Jun 25, 2023
        The fs:all for rank option description was confusing. It seemd
like the fs was optional, but it is mandatory. This change modifies the
help message to reflect the correct way to use all in the --rank option.

Fixes: https://tracker.ceph.com/issues/61753
Signed-off-by: Manish M Yathnalli <[email protected]>
@manishym manishym force-pushed the journal-tool-help-fix branch from 602ce98 to 52c033f Compare June 25, 2023 14:13
@neesingh-rh
Copy link
Contributor

@manishym As suggestions has been addressed now, the PR description also needs updation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cephfs Ceph File System

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants