Skip to content

Windows refine.bat needs to be updated for new arguments matching Linux refine script #5359

@thadguidry

Description

@thadguidry

Windows refine script arguments /d and /x no longer match the Linux refine script and causes confusion for those that maintain across both OS's.

We introduced a few new arguments in the Linux refine script over the last couple of years

  • -d <path> path to the data directory
  • -x <name=value> additional configuration parameters to pass to OpenRefine
  • -v <level> verbosity level [from low to high: error,warn,info,debug,trace]

and replaced two with different arguments (which should no longer are /d and /x as above but instead mimic the Linux refine script as

  • --debug enable JVM debugging (on port 8000)
  • --jmx enable JMX monitoring (for jconsole and jvisualvm)

To Reproduce

Steps to reproduce the behavior:

  1. Start OpenRefine from Cmd Prompt with refine /d "D:\myOpenRefineWorkspace\"
  2. Notice that log output does not show the data directory being set but instead JVM debugging is enabled

Current Results

refine.bat /? is not consistent with the output from Linux with ./refine -h

Expected Behavior

both startup scripts should provide identical arguments, except for differences in shell syntax.
Additionally, /debug and /jmx should be the corresponding argument syntax in refine.bat.
We should also update our user documentation pages where necessary for Windows to reflect the updated arguments.

Screenshots

Versions

  • Operating System: Windows 11
  • Browser Version: Edge latest
  • JRE or JDK Version: JDK 11
  • OpenRefine: Version 3.7-SNAPSHOT [ea70840]

Datasets

Additional context

Metadata

Metadata

Assignees

Labels

Good First IssueIndicates issues suitable for newcomers to design or coding, providing a gentle introduction.Platform: WindowsIndicates that the issue or feature is specific to the Windows operating system.Priority: HighDenotes issues that require urgent attention and may be blocking progress.Type: BugIssues related to software defects or unexpected behavior, which require resolution.Type: DocumentationIssues related to improving project documentation or tutorials.help wantedAn issue that we would love anyone to help us with

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions